tcputil

Nov 8, 2022

Changes in this version

type ServerConfig

+ TLSCert string

+ TLSConfig *tls.Config

+ TLSKey string

Nov 6, 2022

Changes in this version

type ServerConfig

+ MaxClients int

type ServerOpt

+ func MaxClients(maxClients int) ServerOpt

Nov 6, 2022

Changes in this version

+ type ListenMode = int

+ const Both

+ const IPv4_Only

+ const IPv6_Only

+ type ServerConfig struct

+ Address string

+ Mode ListenMode

+ TlsCert string

+ TlsConfig *tls.Config

+ TlsKey string

+ type ServerOpt func(*ServerConfig)

+ func Address(address string) ServerOpt

+ func Mode(mode ListenMode) ServerOpt

+ func TLS(cert, key string, tlsConfig ...*tls.Config) ServerOpt

Nov 6, 2022

Changes in this version

type ClientSocketHandler

+ func PacketFramingHandler(framingProtocol FramingProtocol, readBufferSize int, maxPacketSize int, ...) ClientSocketHandler

+ type PacketFramingContext interface

+ OnPacket func(handler PacketHandler)

+ Socket func() *ClientSocket

type PrefixLength

+ const PrefixInt32_BE

+ const PrefixInt32_LE

Nov 5, 2022

Changes in this version

+ type PacketReader interface

+ OnPacket func(handler func(packet io.Reader))

+ Socket func() *ClientSocket

Nov 5, 2022

Changes in this version

type ClientSocketHandler

+ func FramingHandler(readBufferSize int, maxPacketSize int, framingProtocol FramingProtocol, ...) ClientSocketHandler

type ReadPoolEventHandler

+ func ReadPoolFramingHandler(maxPacketSize int, framingProtocol FramingProtocol, handler PacketHandler) ReadPoolEventHandler

Nov 5, 2022

Changes in this version

type ClientSocketHandler

+ func ReadPoolAdapter(handler ReadPoolEventHandler, readBufferSize int) ClientSocketHandler

type ForkingStrategy

+ func ReadPool(handler ReadPoolEventHandler, maxPoolSize int, readBufferSize int, ...) ForkingStrategy

Nov 5, 2022

Changes in this version

type ClientSocket

+ func (cs *ClientSocket) SetReadDeadline(deadline time.Time) error

+ func (cs *ClientSocket) SetWriteDeadline(deadline time.Time) error

Nov 5, 2022

Changes in this version

type FramingProtocol

+ func LengthPrefixedFraming(prefixLength PrefixLength) FramingProtocol

+ type PrefixLength int

Nov 4, 2022

Changes in this version

+ type FramingProtocol interface

+ ExtractPacket func(readBuffer []byte) (packetData []byte, newReadBuffer []byte, ok bool)

+ func SplitBySeparator(separator []byte) FramingProtocol

type PacketHandler

+ OnPacket func(socket *ClientSocket, packetData []byte)

+ type ReadPoolEventHandler interface

+ OnAccept func(socket *ClientSocket)

+ OnRead func(socket *ClientSocket, data []byte)

+ func PacketFraming(maxPacketSize int, framingProtocol FramingProtocol, handler PacketHandler) ReadPoolEventHandler

Oct 31, 2022

Changes in this version

+ type BulkBroadcaster struct

+ func StartBulkBroadcaster(workersCount, poolSize int, writeQuantum time.Duration) *BulkBroadcaster

+ func (b *BulkBroadcaster) Broadcast(data []byte, targets []*ClientSocket) error

+ func (b *BulkBroadcaster) Stop()

Oct 26, 2022

Changes in this version

type ForkingStrategy

+ OnMetricsUpdate func(metrics *ServerMetrics)

type ServerMetrics

+ Connections int

+ Goroutines int

+ MaxConnections int

+ MaxGoroutines int

Oct 26, 2022

Changes in this version

+ const PrefixInt32

+ var ErrPacketTooBig = errors.New("packet too big")

+ var ErrTimeout = errors.New("timeout")

+ func ReadLengthPrefixedPacket(socket *ClientSocket, prefixSize int, maxPacketSize int) ([]byte, error)

+ func ReadSeparatedPacket(socket *ClientSocket, separator []byte, maxPacketSize int) ([]byte, error)

type ClientSocket

+ func (cs *ClientSocket) IsClosed() bool

+ func (cs *ClientSocket) WrapReader(wrapper func(io.Reader) io.Reader)

+ func (cs *ClientSocket) WrapWriter(wrapper func(io.Writer) io.Writer)

+ type ForkingStrategy interface

+ OnAccept func(socket *ClientSocket)

+ OnStart func()

+ OnStop func()

+ func GoroutinePerConnection(handler ClientSocketHandler) ForkingStrategy

+ func WorkerPool(handler WorkerEventHandler, maxPoolSize int, readBufferSize int, ...) ForkingStrategy

type Server

+ func (s *Server) ForkingStrategy(forkingStrategy ForkingStrategy)

+ type WorkerEventHandler interface

+ OnAccept func(socket *ClientSocket)

+ OnRead func(socket *ClientSocket, data []byte)

Oct 24, 2022

Changes in this version

type ClientSocket

+ func (cs *ClientSocket) Id() int64

type Server

+ func (s *Server) Metrics() ServerMetrics

+ func (s *Server) OnMetricsUpdate(handler func())

+ type ServerMetrics struct

+ ReadsPerSecond uint64

+ TotalRead uint64

+ TotalWritten uint64

+ WritesPerSecond uint64

Oct 22, 2022

Changes in this version

+ type PacketHandlerProvider = func() PacketHandler

Oct 22, 2022

Changes in this version

+ type ClientSocketHandler func(*ClientSocket)

+ func Int32LengthPrefixingHandler(handler PacketHandler, maxPacketSize int) ClientSocketHandler

+ func RawDataHandler(handler PacketHandler) ClientSocketHandler

+ func SeparatorSplittingHandler(handler PacketHandler, separator []byte, maxPacketSize int) ClientSocketHandler

type Server

+ func (s *Server) Handler(handler ClientSocketHandler)

Oct 22, 2022

Changes in this version

type ServerStatistics

+ ReadsPerSecond uint64

Oct 22, 2022

Changes in this version

type ClientSocket

+ func (cs *ClientSocket) ReadsPerSecond() uint64

+ func (cs *ClientSocket) WritesPerSecond() uint64

type Server

+ func (s *Server) OnStatisticsUpdate(handler func())

+ func (s *Server) Statistics() ServerStatistics

+ type ServerStatistics struct

+ ReadPerSecond uint64

+ TotalRead uint64

+ TotalWritten uint64

+ WritesPerSecond uint64

Oct 22, 2022

Changes in this version

+ func ReadBool(reader io.Reader) (bool, error)

+ func ReadByte(reader io.Reader) (byte, error)

+ func ReadByteArray(reader io.Reader) ([]byte, error)

+ func ReadBytes(reader io.Reader, n int) ([]byte, error)

+ func ReadFloat32(reader io.Reader) (float32, error)

+ func ReadFloat64(reader io.Reader) (float64, error)

+ func ReadInt16(reader io.Reader) (int16, error)

+ func ReadInt32(reader io.Reader) (int32, error)

+ func ReadInt64(reader io.Reader) (int64, error)

+ func ReadString(reader io.Reader) (string, error)

+ func ReadVarInt(reader io.Reader) (int, error)

+ func ReadVarLong(reader io.Reader) (int64, error)

+ func WriteBool(writer io.Writer, value bool) error

+ func WriteByte(writer io.Writer, value byte) error

+ func WriteByteArray(writer io.Writer, value []byte) error

+ func WriteBytes(writer io.Writer, value []byte) error

+ func WriteFloat32(writer io.Writer, value float32) error

+ func WriteFloat64(writer io.Writer, value float64) error

+ func WriteInt16(writer io.Writer, value int16) error

+ func WriteInt32(writer io.Writer, value int32) error

+ func WriteInt64(writer io.Writer, value int64) error

+ func WriteString(writer io.Writer, value string) error

+ func WriteVarInt(writer io.Writer, value int) error

+ func WriteVarLong(writer io.Writer, value int64) error

+ type Client struct

+ func Dial(address string) (*Client, error)

+ func DialTLS(address string) (*Client, error)

+ func (c *Client) Close()

+ func (c *Client) OnClose(handler func())

+ func (c *Client) Read(b []byte) (int, error)

+ func (c *Client) Unwrap() net.Conn

+ func (c *Client) UnwrapTLS() (*tls.Conn, bool)

+ func (c *Client) Write(b []byte) (int, error)

type ClientConnectionHandler

+ func Int32PrefixedConnectionHandler(handler PacketHandler, maxPacketSize int) ClientConnectionHandler

+ func SeparatorConnectionHandler(handler PacketHandler, separator []byte, maxPacketSize int) ClientConnectionHandler

type ClientSocket

+ func (cs *ClientSocket) ConnectedAt() time.Time

+ func (cs *ClientSocket) Read(b []byte) (int, error)

+ func (cs *ClientSocket) TotalRead() uint64

+ func (cs *ClientSocket) TotalWritten() uint64

+ func (cs *ClientSocket) Write(b []byte) (int, error)

type PacketHandler

+ OnAccept func(socket *ClientSocket)

type Server

+ func (s *Server) Sockets() []*ClientSocket

Oct 21, 2022

Changes in this version

type ClientConnectionHandler

+ func IntPrefixedConnectionHandler(handler PacketHandler, maxPacketSize uint32) ClientConnectionHandler

Oct 21, 2022

Changes in this version

type ClientConnectionHandler

+ func RawDataConnectionHandler(handler PacketHandler) ClientConnectionHandler

type ClientSocket

+ func (cs *ClientSocket) OnClose(handler func())

+ type PacketHandler interface

+ OnClose func()

+ OnConnection func(socket *ClientSocket)

+ OnData func(data []byte)

Oct 21, 2022

Changes in this version

+ type ClientConnectionHandler func(*ClientSocket)

+ type ClientSocket struct

+ Reader io.Reader

+ RemoteAddress string

+ Writer io.Writer

+ func (cs *ClientSocket) Close()

+ func (cs *ClientSocket) Unwrap() net.Conn

+ func (cs *ClientSocket) UnwrapTLS() (*tls.Conn, bool)

+ type Server struct

+ func NewServer(config *config.Config) *Server

+ func (s *Server) ConnectionHandler(handler ClientConnectionHandler)

+ func (s *Server) Start() error

+ func (s *Server) Stop()