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
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

protocol

package

Go to main page

Versions in this module

v0

v0.0.7

Mar 26, 2026

v0.0.6

Mar 21, 2026

v0.0.5

Mar 21, 2026

v0.0.4

Mar 19, 2026

v0.0.3

Mar 19, 2026

v0.0.2

Mar 18, 2026

v0.0.1

Mar 18, 2026

Changes in this version

+ const HeaderSize

+ const MagicLen

+ const MagicPrivate

+ const MaxMessageSize

+ const MsgAuthRequest

+ const MsgAuthResponse

+ const MsgBatchRequest

+ const MsgBatchResponse

+ const MsgClose

+ const MsgError

+ const MsgHandshakeRequest

+ const MsgHandshakeResponse

+ const MsgPing

+ const MsgPong

+ const MsgQueryRequest

+ const MsgQueryResponse

+ const ProtocolV1

+ const ProtocolV2

+ const ProtocolV3

+ const StatusAuth

+ const StatusError

+ const StatusOK

+ func MessageType(t byte) string

+ func WriteMessage(w io.Writer, msgType byte, seqID uint32, payload []byte) error

+ type AuthRequest struct

+ Database string

+ Password []byte

+ Username string

+ func DecodeAuthRequest(payload []byte) (*AuthRequest, error)

+ func (r *AuthRequest) Encode() []byte

+ type AuthResponse struct

+ Message string

+ Permission uint32

+ SessionID string

+ Status byte

+ func DecodeAuthResponse(payload []byte) (*AuthResponse, error)

+ func (r *AuthResponse) Encode() []byte

+ type ColumnInfo struct

+ Name string

+ Nullable bool

+ Type string

+ type ConnectionHandler struct

+ func NewConnectionHandler(conn net.Conn, opts ...ConnectionOption) *ConnectionHandler

+ func (h *ConnectionHandler) Close() error

+ func (h *ConnectionHandler) CreatedAt() time.Time

+ func (h *ConnectionHandler) Database() string

+ func (h *ConnectionHandler) Handle(ctx context.Context) error

+ func (h *ConnectionHandler) IsClosed() bool

+ func (h *ConnectionHandler) LastActiveAt() time.Time

+ func (h *ConnectionHandler) LocalAddr() net.Addr

+ func (h *ConnectionHandler) RemoteAddr() net.Addr

+ func (h *ConnectionHandler) SessionID() string

+ func (h *ConnectionHandler) Username() string

+ type ConnectionOption func(*ConnectionHandler)

+ func WithAuthHandler(fn func(conn *ConnectionHandler, req *AuthRequest) (*AuthResponse, error)) ConnectionOption

+ func WithCloseHandler(fn func(conn *ConnectionHandler)) ConnectionOption

+ func WithHandshakeHandler(...) ConnectionOption

+ func WithMaxMessageSize(size uint32) ConnectionOption

+ func WithQueryHandler(fn func(conn *ConnectionHandler, req *QueryRequest) (*QueryResponse, error)) ConnectionOption

+ func WithReadTimeout(d time.Duration) ConnectionOption

+ func WithWriteTimeout(d time.Duration) ConnectionOption

+ type ConnectionState int32

+ const StateAuth

+ const StateClosed

+ const StateClosing

+ const StateHandshake

+ const StateInit

+ const StateQuery

+ const StateReady

+ func (s ConnectionState) String() string

+ type ErrorPayload struct

+ Code uint32

+ Detail string

+ Message string

+ func DecodeErrorPayload(payload []byte) (*ErrorPayload, error)

+ func (e *ErrorPayload) Encode() []byte

+ type HandshakeRequest struct

+ ClientInfo string

+ ClientVersion string

+ Extensions []string

+ ProtocolVersion uint16

+ func DecodeHandshakeRequest(payload []byte) (*HandshakeRequest, error)

+ func (r *HandshakeRequest) Encode() []byte

+ type HandshakeResponse struct

+ AuthChallenge []byte

+ Downgrade bool

+ Extensions []string

+ ProtocolVersion uint16

+ ServerVersion string

+ Supported bool

+ func DecodeHandshakeResponse(payload []byte) (*HandshakeResponse, error)

+ func (r *HandshakeResponse) Encode() []byte

+ type Header struct

+ Length uint32

+ Magic [MagicLen]byte

+ SeqID uint32

+ Type byte

+ func ReadHeader(r io.Reader) (*Header, error)

+ type Message struct

+ Header Header

+ Payload []byte

+ func DecodeMessage(data []byte) (*Message, error)

+ func NewMessage(msgType byte, seqID uint32, payload []byte) *Message

+ func ReadMessage(r io.Reader) (*Message, error)

+ func (m *Message) Encode() ([]byte, error)

+ type QueryRequest struct

+ BatchMode bool

+ Params [][]byte

+ SQL string

+ func DecodeQueryRequest(payload []byte) (*QueryRequest, error)

+ func (r *QueryRequest) Encode() []byte

+ type QueryResponse struct

+ Affected uint32

+ Columns []ColumnInfo

+ ExecuteTime uint32

+ LastInsertID uint64

+ Message string

+ RowCount uint32

+ Rows [][]interface{}

+ Status byte

+ func DecodeQueryResponse(payload []byte) (*QueryResponse, error)

+ func (r *QueryResponse) Encode() []byte

+ type Server struct

+ func NewServer(config *ServerConfig) *Server

+ func (s *Server) Addr() net.Addr

+ func (s *Server) Broadcast(msgType byte, payload []byte) error

+ func (s *Server) ConnectionCount() int

+ func (s *Server) Connections() []*ConnectionHandler

+ func (s *Server) IsRunning() bool

+ func (s *Server) SetAuthHandler(fn func(conn *ConnectionHandler, req *AuthRequest) (*AuthResponse, error))

+ func (s *Server) SetConnectHandler(fn func(conn *ConnectionHandler))

+ func (s *Server) SetDisconnectHandler(fn func(conn *ConnectionHandler))

+ func (s *Server) SetHandshakeHandler(...)

+ func (s *Server) SetQueryHandler(fn func(conn *ConnectionHandler, req *QueryRequest) (*QueryResponse, error))

+ func (s *Server) Start() error

+ func (s *Server) Stop() error

+ type ServerConfig struct

+ AcceptBacklog int

+ Bind string

+ MaxConnections int

+ MaxMessageSize uint32

+ Port int

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ func DefaultServerConfig() *ServerConfig