proto

type Begin ¶

type Begin struct {
	Extra map[string]packstream.Value
}

Begin starts an explicit transaction. Fields: [extra map].

type ChunkedReader ¶

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

ChunkedReader reassembles a complete Bolt message from a sequence of length-prefixed chunks read from an underlying buffered reader.

Wire format (per chunk):

uint16 big-endian length  (0 = end-of-message sentinel)
<length bytes of payload>

Bounded growth: every ChunkedReader carries a maxMessageBytes cap (configured via NewChunkedReaderWithLimit; defaults to DefaultMaxMessageBytes for NewChunkedReader). When the cumulative payload of a single message would exceed the cap, ReadMessage returns ErrMessageTooLarge before performing the would-be-oversized allocation. This closes the Slowloris-style DoS vector where a single client streams non-zero chunks until the server OOMs.

ChunkedReader is NOT safe for concurrent use.

func NewChunkedReader(r io.Reader) *ChunkedReader

func NewChunkedReaderWithLimit(r io.Reader, maxMessageBytes int) *ChunkedReader

func (cr *ChunkedReader) ReadMessage() ([]byte, error)

type ChunkedWriter ¶

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

ChunkedWriter frames a logical Bolt message into one or more chunks and writes them to the underlying buffered writer, followed by the uint16(0) end-of-message sentinel. It then flushes the buffer.

ChunkedWriter is NOT safe for concurrent use.

func NewChunkedWriter(w io.Writer) *ChunkedWriter

func (cw *ChunkedWriter) WriteMessage(msg []byte) error

type Commit ¶

type Commit struct{}

Commit commits the current explicit transaction. Fields: none.

type Discard ¶

type Discard struct {
	N   int64
	QID int64
}

Discard discards pending records without streaming them to the client. Fields: [extra map {n: int64, qid: int64}].

type Failure ¶

type Failure struct {
	Code    string
	Message string
}

Failure indicates that the preceding request failed. Fields: [metadata map {code string, message string}].

type Goodbye ¶

type Goodbye struct{}

Goodbye signals orderly connection teardown. Fields: none.

type Hello ¶

type Hello struct {
	Extra map[string]packstream.Value
}

Hello is sent by the client to initiate a Bolt connection. Fields: [extra map] containing agent, bolt_agent, scheme, principal, credentials, routing, and other driver metadata.

type Ignored ¶

type Ignored struct{}

Ignored indicates that the preceding request was ignored (e.g., the connection is in a failed state). Fields: none.

type Logoff ¶

type Logoff struct{}

Logoff ends an authenticated session without closing the connection. Fields: none.

type Logon ¶

type Logon struct {
	Auth map[string]packstream.Value
}

Logon sends authentication credentials on an established connection. Fields: [auth map].

type Pull ¶

type Pull struct {
	N   int64
	QID int64
}

Pull requests records from the server. Fields: [extra map {n: int64, qid: int64}]. n=-1 means pull all; qid=-1 means the most recent query.

type Record ¶

type Record struct {
	Data []packstream.Value
}

Record carries one row of result data from a query. Fields: [data list].

type Reset ¶

type Reset struct{}

Reset returns the connection to a clean, ready state, discarding any pending results and rolling back any open transaction. Fields: none.

type Rollback ¶

type Rollback struct{}

Rollback rolls back the current explicit transaction. Fields: none.

type Route ¶

type Route struct {
	Routing   map[string]packstream.Value
	Bookmarks []packstream.Value
	DB        packstream.Value // string or nil
}

Route requests routing table information. Fields: [routing map, bookmarks list, db string|null].

type Run ¶

type Run struct {
	Query      string
	Parameters map[string]packstream.Value
	Extra      map[string]packstream.Value
}

Run submits a Cypher query for execution. Fields: [query string, parameters map, extra map].

type Success ¶

type Success struct {
	Metadata map[string]packstream.Value
}

Success indicates that the preceding request succeeded. Fields: [metadata map].

type Version ¶

type Version struct {
	Major, Minor uint8
}

Version represents a Bolt protocol version.

func Negotiate(ctx context.Context, conn net.Conn) (Version, error)

[0x00, minor_range, minor, major]