interfaces

Documentation

Index

• Constants
• type AbstractDialer
• type AbstractListener
• type ErrorCorrectionFacility
• type ErrorCorrectionFacilityFactory
• type ExtraOptionsAbstractDialerValue
• type ExtraOptionsAbstractListenerValue
• type ExtraOptionsBoostConnectionGracefulShutdownRequestValue
• type ExtraOptionsBoostConnectionSettingsHTTPTransportValue
• type ExtraOptionsBoostConnectionShouldNotRedialValue
• type ExtraOptionsFECPacketAssemblyOptValue
• type ExtraOptionsHTTPDialAddrValue
• type ExtraOptionsHTTPNetworkBufferSizeValue
• type ExtraOptionsHTTPServerStreamRelayValue
• type ExtraOptionsLocalUDPBindPortValue
• type ExtraOptionsUDPInitialDataValue
• type ExtraOptionsUDPTimeoutTimeValue
• type ExtraOptionsUniConnAttribValue
• type ExtraOptionsUsePacketArmorValue
• type GetTransmitLayerSentRecvStats
• type Masker
• type QualityEstimator
• type RSParityShardSum
• type StreamRelayer
• type SurrogateDialer
• type TrafficWithChannelTag
• type UDPPacket

Constants

const ExtraOptionsAbstractDialer = "ExtraOptionsUseAbstractDialer"

const ExtraOptionsAbstractListener = "ExtraOptionsUseAbstractListener"

const ExtraOptionsBoostConnectionGracefulShutdownRequest = "ExtraOptionsBoostConnectionGracefulShutdownRequest"

const ExtraOptionsBoostConnectionSettingsHTTPTransport = "ExtraOptionsBoostConnectionSettingsHTTPTransport"

const ExtraOptionsBoostConnectionShouldNotRedial = "ExtraOptionsBoostConnectionShouldNotRedial"

const ExtraOptionsConnID = "ExtraOptionsConnID"

const ExtraOptionsDisableAutoQuitForClient = "ExtraOptionsDisableAutoQuitForClient"

const ExtraOptionsDisableFEC = "ExtraOptionsDisableFEC"

const ExtraOptionsFECPacketAssemblyOpt = "ExtraOptionsFECPacketAssemblyOpt"

const ExtraOptionsHTTPClientDialAlternativeChannel = "ExtraOptionsHTTPClientDialAlternativeChannel"

const ExtraOptionsHTTPDialAddr = "ExtraOptionsHTTPDialAddr"

const ExtraOptionsHTTPNetworkBufferSize = "ExtraOptionsHTTPNetworkBufferSize"

const ExtraOptionsHTTPServerStreamRelay = "ExtraOptionsHTTPServerStreamRelay"

const ExtraOptionsHTTPTransportConnIsBoostConnection = "ExtraOptionsHTTPTransportConnIsBoostConnection"

const ExtraOptionsHTTPUseSystemHTTPProxy = "ExtraOptionsHTTPUseSystemHTTPProxy"

const ExtraOptionsHTTPUseSystemSocksProxy = "ExtraOptionsHTTPUseSystemSocksProxy"

const ExtraOptionsLocalUDPBindPort = "ExtraOptionsLocalUDPBindPort"

const ExtraOptionsMessageBus = "ExtraOptionsMessageBus"

const ExtraOptionsMessageBusByConn = "ExtraOptionsMessageBusByConn"

const ExtraOptionsUDPFECEnabled = "ExtraOptionsUDPFECEnabled"

const ExtraOptionsUDPInitialData = "ExtraOptionsUDPInitialData"

const ExtraOptionsUDPMask = "ExtraOptionsUDPMask"

const ExtraOptionsUDPShouldMask = "ExtraOptionsUDPShouldMask"

const ExtraOptionsUDPTimeoutTime = "ExtraOptionsUDPTimeoutTime"

const ExtraOptionsUniConnAttrib = "ExtraOptionsUniConnAttrib"

const ExtraOptionsUsePacketArmor = "ExtraOptionsUsePacketArmor"

const ExtraOptionsUseWebSocketInsteadOfHTTP = "ExtraOptionsUseWebSocketInsteadOfHTTP"

Types

type AbstractDialer

type AbstractDialer interface {
	Dial(ctx context.Context, token string) (net.Conn, error)
}

type AbstractListener

type AbstractListener interface {
	Accept(ctx context.Context) (net.Conn, string, error)
}

type ErrorCorrectionFacility

type ErrorCorrectionFacility interface {
	AddShard(id int, data []byte) (done bool, encoded []byte)
	Reconstruct() [][]byte

	AddData(data []byte) (id int, wrappedData []byte)
	ConstructReconstructShard() (id int, encoded []byte, more bool)

	MaxShardYieldRemaining() int
}

type ErrorCorrectionFacilityFactory

type ErrorCorrectionFacilityFactory interface {
	Create(ctx context.Context) ErrorCorrectionFacility
}

type ExtraOptionsAbstractDialerValue

type ExtraOptionsAbstractDialerValue struct {
	AbsDialer    AbstractDialer
	UseAbsDialer bool
}

type ExtraOptionsAbstractListenerValue

type ExtraOptionsAbstractListenerValue struct {
	AbsListener    AbstractListener
	UseAbsListener bool
}

type ExtraOptionsBoostConnectionGracefulShutdownRequestValue

type ExtraOptionsBoostConnectionGracefulShutdownRequestValue struct {
	ShouldClose chan interface{}
}

type ExtraOptionsBoostConnectionSettingsHTTPTransportValue

type ExtraOptionsBoostConnectionSettingsHTTPTransportValue struct {
	MaxBoostTxConnection int
	MaxBoostRxConnection int
}

type ExtraOptionsBoostConnectionShouldNotRedialValue

type ExtraOptionsBoostConnectionShouldNotRedialValue struct {
	ShouldNotReDial int32
}

type ExtraOptionsFECPacketAssemblyOptValue

type ExtraOptionsFECPacketAssemblyOptValue struct {
	RxMaxTimeInSecond int
	TxEpochTimeInMs   int
}

type ExtraOptionsHTTPDialAddrValue

type ExtraOptionsHTTPDialAddrValue struct {
	Addr string
}

type ExtraOptionsHTTPNetworkBufferSizeValue

type ExtraOptionsHTTPNetworkBufferSizeValue struct {
	NetworkBufferSize int
}

type ExtraOptionsHTTPServerStreamRelayValue

type ExtraOptionsHTTPServerStreamRelayValue struct {
	Relay StreamRelayer
}

type ExtraOptionsLocalUDPBindPortValue

type ExtraOptionsLocalUDPBindPortValue struct {
	LocalPort uint16
	LocalIP   *net.IP
}

type ExtraOptionsUDPInitialDataValue

type ExtraOptionsUDPInitialDataValue struct {
	Data []byte
}

type ExtraOptionsUDPTimeoutTimeValue

type ExtraOptionsUDPTimeoutTimeValue struct {
	TimeoutTimeInSeconds int
}

type ExtraOptionsUniConnAttribValue

type ExtraOptionsUniConnAttribValue struct {
	ID   []byte
	Rand []byte
	Iter int32
}

type ExtraOptionsUsePacketArmorValue

type ExtraOptionsUsePacketArmorValue struct {
	PacketArmorPaddingTo int
	UsePacketArmor       bool
}

type GetTransmitLayerSentRecvStats

type GetTransmitLayerSentRecvStats interface {
	GetTransmitLayerSentRecvStats() (uint64, uint64)
}

type Masker

type Masker interface {
	Mask(input io.Reader, output io.Writer) error
	UnMask(input io.Reader, output io.Writer) error
}

type QualityEstimator

type QualityEstimator interface {
	OnSendPing(ping proto.PingHeader)
	OnReceivePong(pong proto.PongHeader)
}

type RSParityShardSum

type RSParityShardSum struct {
	ParityLookupTable []int
}

type StreamRelayer

type StreamRelayer interface {
	RelayStream(conn io.ReadWriteCloser, ctx context.Context)
}

type SurrogateDialer

type SurrogateDialer interface {
	Dial(network, address string, port uint16, ctx context.Context) (net.Conn, error)
	NotifyMeltdown(reason error)
}

type TrafficWithChannelTag

type TrafficWithChannelTag struct {
	Channel uint16
	Payload []byte
}

type UDPPacket

type UDPPacket struct {
	Source  *net.UDPAddr
	Dest    *net.UDPAddr
	Payload []byte
}