transport

Documentation

Index

• Constants
• func NewPollingTransport(chanBuf int) func(SessionID, Codec) Transporter
• func NewWebsocketTransport(chanBuf int) func(SessionID, Codec) Transporter
• type Codec
• type HTTPCompressionKind
• type Name
  • func (name Name) String() string
• type Option
  • func OnInitProbe(b bool) Option
  • func OnUpgrade(fn func() error) Option
  • func WithBufferedReader() Option
  • func WithCodec(codec Codec) Option
  • func WithGovernor(minTime, sleep time.Duration) Option
  • func WithHTTPCompression(kind HTTPCompressionKind) Option
  • func WithNoPing() Option
  • func WithPerMessageDeflate(kind HTTPCompressionKind) Option
  • func WithPollingSleep(d time.Duration) Option
• type OptionWith
• type PollingTransport
  • func (t *PollingTransport) InnerTransport() *Transport
  • func (t *PollingTransport) Run(w http.ResponseWriter, r *http.Request, opts ...Option) (err error)
  • func (t *PollingTransport) With(opts ...Option)
  • func (t *PollingTransport) Write(w http.ResponseWriter, r *http.Request) error
• type SessionID
• type StartWriteBuffer
  • func (StartWriteBuffer) Len() int
• type Transport
  • func (t *Transport) ID() SessionID
  • func (t *Transport) Name() Name
  • func (t *Transport) Receive() <-chan eiop.Packet
  • func (t *Transport) ReceiveTimeout() <-chan SessionID
  • func (t *Transport) Send(packet eiop.Packet)
  • func (t *Transport) SendTimeout()
  • func (t *Transport) Shutdown()
  • func (t *Transport) Transport() *Transport
• type Transporter
• type WaitGroup
• type WebsocketTransport
  • func (t *WebsocketTransport) ConnClose(code ws.StatusCode, reason string, ctx context.Context) error
  • func (t *WebsocketTransport) InnerTransport() *Transport
  • func (t *WebsocketTransport) Run(w http.ResponseWriter, r *http.Request, opts ...Option) (err error)
  • func (t *WebsocketTransport) With(opts ...Option)
• type WriteClose
  • func (wc WriteClose) SocketCloseChannel() error

Constants

const (
	ErrDecodeFailed        erro.StringF = "failed to decode the %q transport:: %w"
	ErrEncodeFailed        erro.StringF = "failed to encode the %q transport:: %w"
	ErrUnimplementedMethod erro.StringF = "unimplemented %s method"
	ErrCloseSocket         erro.State   = "socket: closed"
	ErrTimeoutSocket       erro.State   = "socket: timeout"
)

Functions

func NewPollingTransport

func NewPollingTransport(chanBuf int) func(SessionID, Codec) Transporter

func NewWebsocketTransport

func NewWebsocketTransport(chanBuf int) func(SessionID, Codec) Transporter

Types

type Codec

type Codec struct {
	eiop.PacketEncoder
	eiop.PacketDecoder
	eiop.PayloadEncoder
	eiop.PayloadDecoder
}

type HTTPCompressionKind

type HTTPCompressionKind string

const (
	CompressGZIP HTTPCompressionKind = "gzip"
)

type Name

type Name string

const (
	Polling Name = "polling"
)

const Websocket Name = "websocket"

func (Name) String

func (name Name) String() string

type Option

type Option = with.Option

func OnInitProbe

func OnInitProbe(b bool) Option

func OnUpgrade

func OnUpgrade(fn func() error) Option

func WithBufferedReader

func WithBufferedReader() Option

func WithCodec

func WithCodec(codec Codec) Option

func WithGovernor

func WithGovernor(minTime, sleep time.Duration) Option

func WithHTTPCompression

func WithHTTPCompression(kind HTTPCompressionKind) Option

func WithNoPing

func WithNoPing() Option

func WithPerMessageDeflate

func WithPerMessageDeflate(kind HTTPCompressionKind) Option

func WithPollingSleep

func WithPollingSleep(d time.Duration) Option

type OptionWith

type OptionWith = with.OptionWith

type PollingTransport

type PollingTransport struct {
	*Transport
	// contains filtered or unexported fields
}

func (*PollingTransport) InnerTransport

func (t *PollingTransport) InnerTransport() *Transport

func (*PollingTransport) Run

func (t *PollingTransport) Run(w http.ResponseWriter, r *http.Request, opts ...Option) (err error)

func (*PollingTransport) With

func (t *PollingTransport) With(opts ...Option)

func (*PollingTransport) Write

func (t *PollingTransport) Write(w http.ResponseWriter, r *http.Request) error

type SessionID

type SessionID = eios.ID

type StartWriteBuffer

type StartWriteBuffer func() bool

func (StartWriteBuffer) Len

func (StartWriteBuffer) Len() int

type Transport

type Transport struct {
	// contains filtered or unexported fields
}

func (*Transport) ID

func (t *Transport) ID() SessionID

func (*Transport) Name

func (t *Transport) Name() Name

func (*Transport) Receive

func (t *Transport) Receive() <-chan eiop.Packet

func (*Transport) ReceiveTimeout

func (t *Transport) ReceiveTimeout() <-chan SessionID

func (*Transport) Send

func (t *Transport) Send(packet eiop.Packet)

func (*Transport) SendTimeout

func (t *Transport) SendTimeout()

func (*Transport) Shutdown

func (t *Transport) Shutdown()

func (*Transport) Transport

func (t *Transport) Transport() *Transport

type Transporter

type Transporter interface {
	ID() SessionID
	Name() Name
	Send(eiop.Packet)
	Receive() <-chan eiop.Packet
	SendTimeout()
	ReceiveTimeout() <-chan SessionID
	Run(http.ResponseWriter, *http.Request, ...Option) error

	Shutdown()
}

type WaitGroup

type WaitGroup interface {
	Add(int)
	Done()
	Wait()
}

type WebsocketTransport

type WebsocketTransport struct {
	*Transport

	PingMsg string
	// contains filtered or unexported fields
}

func (*WebsocketTransport) ConnClose

func (t *WebsocketTransport) ConnClose(code ws.StatusCode, reason string, ctx context.Context) error

func (*WebsocketTransport) InnerTransport

func (t *WebsocketTransport) InnerTransport() *Transport

func (*WebsocketTransport) Run

func (t *WebsocketTransport) Run(w http.ResponseWriter, r *http.Request, opts ...Option) (err error)

func (*WebsocketTransport) With

func (t *WebsocketTransport) With(opts ...Option)

type WriteClose

type WriteClose struct {
	// contains filtered or unexported fields
}

func (WriteClose) SocketCloseChannel

func (wc WriteClose) SocketCloseChannel() error