Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

arctic

package module

Go to main page

Versions in this module

v0

v0.0.3

Aug 25, 2026

v0.0.2

Aug 25, 2026

Changes in this version

+ var ErrEndpointInUse error = errors.New("arctic: endpoint is already in use")

+ var ErrSidecarAlreadyAttached error = errors.New("arctic: websocket sidecar is already attached")

type Protocol

+ const ProtocolWebSocket

type Server

+ func (server *Server) AddWebSocketSidecar(sidecar *WebSocketServer) (err error)

+ type WebSocketServer struct

+ func NewWebSocketServer(config WebSocketServerConfig) (server *WebSocketServer, err error)

+ func (server *WebSocketServer) Addr() (addr net.Addr)

+ type WebSocketServerConfig struct

+ BindAddress string

+ OriginPatterns []string

+ Path string

+ Timeout time.Duration

v0.0.1

Aug 25, 2026

Changes in this version

+ var ErrClientNotConnected error = errors.New("arctic: client is not connected")

+ var ErrGobTypeInvalid error = errors.New("arctic: gob message type must be a struct")

+ var ErrGobTypeNotRegistered error = errors.New("arctic: gob message type is not registered")

+ var ErrGobTypeRegistrationFailed error = errors.New("arctic: gob message type registration failed")

+ var ErrMessageTooLarge error = errors.New("arctic: message exceeds configured buffer size")

+ var ErrMetadataInvalid error = errors.New("arctic: metadata is invalid")

+ var ErrProtocolUnsupported error = errors.New("arctic: protocol is not supported")

+ var ErrServerAlreadyListening error = errors.New("arctic: server is already listening")

+ func IsGobTypeRegistered[MessageType any]() (registered bool)

+ func RegisterGobType[MessageType any](sample MessageType) (err error)

+ type Client struct

+ func NewClient(config ClientConfig) (client *Client, err error)

+ func (client *Client) Close() (err error)

+ func (client *Client) Connect() (err error)

+ func (client *Client) LocalAddr() (addr net.Addr)

+ func (client *Client) Metadata() (metadata map[string]any)

+ func (client *Client) OnClose(handler CloseHandler)

+ func (client *Client) OnError(handler ErrorHandler)

+ func (client *Client) OnMessage(handler MessageHandler)

+ func (client *Client) RemoteAddr() (addr net.Addr)

+ func (client *Client) Send(message []byte) (err error)

+ func (client *Client) Use(middleware ...Middleware)

+ type ClientConfig struct

+ BufferSize int

+ Metadata map[string]any

+ Protocol Protocol

+ ServerAddress string

+ Timeout time.Duration

+ UnsafeZeroCopy bool

+ type ClientHandler func(*ServerClient)

+ type CloseHandler func()

+ type ErrorHandler func(error)

+ type GobClient struct

+ func NewGobClient[MessageType any](config ClientConfig) (client *GobClient[MessageType], err error)

+ func (client *GobClient[MessageType]) Connect() (err error)

+ func (client *GobClient[MessageType]) OnMessage(handler GobMessageHandler[MessageType])

+ func (client *GobClient[MessageType]) Send(message MessageType) (err error)

+ func (client *GobClient[MessageType]) Use(middleware ...GobMiddleware[MessageType])

+ type GobClientHandler func(*GobServerClient[MessageType])

+ type GobMessageContext struct

+ Client *GobClient[MessageType]

+ Message MessageType

+ type GobMessageHandler func(MessageType)

+ type GobMiddleware func(*GobMessageContext[MessageType], GobNext[MessageType]) error

+ type GobNext func(*GobMessageContext[MessageType]) error

+ type GobServer struct

+ func NewGobServer[MessageType any](config ServerConfig) (server *GobServer[MessageType], err error)

+ func (server *GobServer[MessageType]) Close() (err error)

+ func (server *GobServer[MessageType]) Listen() (err error)

+ func (server *GobServer[MessageType]) OnClient(handler GobClientHandler[MessageType])

+ type GobServerClient struct

+ func (serverClient *GobServerClient[MessageType]) ID() (id int)

+ type MessageContext struct

+ Client *Client

+ Message []byte

+ type MessageHandler func([]byte)

+ type Middleware func(*MessageContext, Next) error

+ type Next func(*MessageContext) error

+ type Protocol string

+ const ProtocolTCP

+ const ProtocolUDP

+ type Server struct

+ func NewServer(config ServerConfig) (server *Server, err error)

+ func (server *Server) Addr() (addr net.Addr)

+ func (server *Server) Close() (err error)

+ func (server *Server) Listen() (err error)

+ func (server *Server) OnClient(handler ClientHandler)

+ func (server *Server) OnClose(handler CloseHandler)

+ func (server *Server) OnError(handler ErrorHandler)

+ type ServerClient struct

+ func (serverClient *ServerClient) ID() (id int)

+ type ServerConfig struct

+ BindAddress string

+ BufferSize int

+ Protocol Protocol

+ Timeout time.Duration

+ UnsafeZeroCopy bool