protocol

package

Go to main page

Versions in this module

v0

v0.26.0

Oct 6, 2026

v0.25.0

Oct 6, 2026

v0.24.0

Oct 6, 2026

v0.23.0

Oct 5, 2026

v0.22.0

Oct 5, 2026

v0.21.0

Oct 4, 2026

v0.20.0

Oct 4, 2026

v0.19.0

Oct 3, 2026

v0.18.0

Oct 3, 2026

v0.17.0

Sep 30, 2026

v0.16.0

Sep 28, 2026

v0.15.0

Sep 27, 2026

v0.14.0

Sep 27, 2026

v0.13.0

Sep 27, 2026

v0.12.0

Sep 26, 2026

v0.11.0

Sep 23, 2026

Changes in this version

+ const MaxSyncPeerChars

type HeartbeatRequest

+ SyncPeer *string

type SessionRecord

+ SyncPeer *string

type SessionRegistration

+ SyncPeer *string

type WatchCommand

+ SyncPeer *string

v0.10.0

Sep 20, 2026

Changes in this version

+ const MaxBrigadeVersionChars

type HeartbeatRequest

+ BrigadeVersion *string

type SessionRecord

+ BrigadeVersion *string

type SessionRegistration

+ BrigadeVersion *string

type WatchCommand

+ BrigadeVersion *string

v0.9.1

Sep 20, 2026

v0.9.0

Sep 20, 2026

v0.8.1

Sep 20, 2026

v0.8.0

Sep 20, 2026

v0.7.0

Sep 20, 2026

Changes in this version

+ func TruncateRunes(s string, limit int) string

v0.6.7

Sep 18, 2026

v0.6.6

Sep 18, 2026

Changes in this version

type SessionRegistration

+ HumanLabel *string

v0.6.5

Sep 17, 2026

v0.6.4

Sep 14, 2026

v0.6.3

Sep 14, 2026

v0.6.2

Sep 14, 2026

v0.6.1

Sep 13, 2026

v0.6.0

Sep 13, 2026

v0.5.2

Sep 11, 2026

v0.5.1

Sep 10, 2026

v0.5.0

Sep 10, 2026

Changes in this version

+ const MaxContextUsedTokens

+ const MaxModelChars

+ func SanitizeModel(s string) string

type HeartbeatRequest

+ ContextUsedTokens *int

+ Model *string

type Limits

+ MaxModelChars int

type SessionRecord

+ ContextUsedTokens *int

+ Model *string

type SessionRegistration

+ ContextUsedTokens *int

+ Model *string

type WatchCommand

+ ContextUsedTokens *int

+ Model *string

v0.4.1

Sep 8, 2026

v0.4.0

Sep 8, 2026

v0.3.0

Sep 8, 2026

v0.2.0

Sep 7, 2026

v0.1.0

Sep 6, 2026

Changes in this version

+ const AckStateInjected

+ const AckStateProcessed

+ const ActivityBusy

+ const ActivityIdle

+ const CommandAck

+ const CommandClose

+ const CommandHeartbeat

+ const DeliveryStateAccepted

+ const DeliveryStateInjected

+ const DeliveryStateProcessed

+ const EventAcked

+ const EventError

+ const EventHeartbeatOK

+ const EventMessage

+ const EventReady

+ const EventStatus

+ const ExitOK

+ const GuaranteeAtLeastOnce

+ const ImplicitReplyWindowSeconds

+ const InboundAccept

+ const InboundHold

+ const InboundRefuse

+ const JoinSecretPrefix

+ const KindText

+ const LeaseDefaultSeconds

+ const LeaseMaxSeconds

+ const LeaseMinSeconds

+ const MaxBodyBytes

+ const MaxDescriptionChars

+ const MaxHopCount

+ const MaxHumanLabelChars

+ const MaxIdempotencyKeyChars

+ const MaxLineBytes

+ const MaxSessionNameCodepoints

+ const MaxSummaryChars

+ const MaxTeamNameCodepoints

+ const MaxUnackedPerRecipient

+ const MaxUnackedPerSenderRecipient

+ const MaxWorkspaceLabelChars

+ const PrincipalSendRatePerHour

+ const PrincipalSendRatePerMinute

+ const ProfileStateJoined

+ const ProfileStateNotMember

+ const ProfileStateUnauthenticated

+ const ProfileStateUnconfigured

+ const ProtocolVersion

+ const RetentionAckedMessageSeconds

+ const RetentionClosedSessionSeconds

+ const RetentionUnackedMessageSeconds

+ const SendRatePerHour

+ const SendRatePerMinute

+ const SendStatusAccepted

+ const SessionStateActive

+ const SessionStateIdle

+ const SessionStateOffline

+ const StatusStateLive

+ const StatusStatePolling

+ const TruncationMarker

+ const WatchModePolling

+ const WatchModePush

+ var ErrLineTooLong = errors.New("ndjson line exceeds 1 MiB and was dropped")

+ func Decode(data []byte, v Validator) error

+ func Sanitize(s string) string

+ func SanitizeAttribute(s string) string

+ func SanitizeBody(s string) string

+ func SanitizeDescription(s string) string

+ func SanitizeLabel(s string) string

+ func SanitizeName(s string) string

+ func SanitizeSummary(s string) string

+ func Unmarshal(data []byte, v any) error

+ type AckRequest struct

+ MessageIDs []string

+ func (r *AckRequest) Validate() error

+ type AckResult struct

+ Acked []string

+ Unknown []string

+ func (r *AckResult) Validate() error

+ type AdapterInfo struct

+ Name string

+ Version string

+ type Code string

+ const CodeConfig

+ const CodeConflict

+ const CodeInternal

+ const CodeInvalidInput

+ const CodeLoopDetected

+ const CodeNotFound

+ const CodeProtocolMismatch

+ const CodeRateLimited

+ const CodeUnauthenticated

+ const CodeUnauthorized

+ const CodeUnavailable

+ const CodeUsage

+ func (c Code) Exit() int

+ func (c Code) Retryable() bool

+ type DeliveryInfo struct

+ AckState string

+ Guarantee string

+ Ordering string

+ type DescribeResult struct

+ Adapter AdapterInfo

+ Capabilities []string

+ Delivery DeliveryInfo

+ Lease Lease

+ Limits Limits

+ Profile ProfileInfo

+ ProtocolVersion string

+ Retention Retention

+ func (d *DescribeResult) Validate() error

+ type Envelope struct

+ Error *ErrorObject

+ OK bool

+ ProtocolVersion string

+ Result jsontext.Value

+ func (e *Envelope) Validate() error

+ type Error struct

+ Code Code

+ Details map[string]string

+ Message string

+ RetryAfterMS int

+ func (e *Error) Error() string

+ func (e *Error) Object() *ErrorObject

+ type ErrorObject struct

+ Code Code

+ Details map[string]string

+ Message string

+ RetryAfterMS int

+ Retryable bool

+ func (e *ErrorObject) Validate() error

+ type HeartbeatRequest struct

+ Activity *string

+ Inbound *string

+ LeaseSeconds *int

+ SessionDescription *string

+ SessionName *string

+ func (h *HeartbeatRequest) Validate() error

+ type HeartbeatResult struct

+ LeaseUntil time.Time

+ ServerTime time.Time

+ SessionID string

+ State string

+ func (h *HeartbeatResult) Validate() error

+ type JoinSecret struct

+ func ParseJoinSecret(s string) (JoinSecret, error)

+ func (s JoinSecret) GoString() string

+ func (s JoinSecret) LogValue() slog.Value

+ func (s JoinSecret) MarshalJSON() ([]byte, error)

+ func (s JoinSecret) Secret() string

+ func (s JoinSecret) String() string

+ func (s JoinSecret) TeamRef() string

+ type Lease struct

+ DefaultSeconds int

+ MaxSeconds int

+ MinSeconds int

+ func DefaultLease() Lease

+ func (l Lease) CheckSeconds(field string, v *int) error

+ type Limits struct

+ ImplicitReplyWindowSeconds int

+ MaxBodyBytes int

+ MaxDescriptionChars int

+ MaxHopCount int

+ MaxHumanLabelChars int

+ MaxIdempotencyKeyChars int

+ MaxSessionNameCodepoints int

+ MaxSummaryChars int

+ MaxTeamNameCodepoints int

+ MaxUnackedPerRecipient int

+ MaxUnackedPerSenderRecipient int

+ MaxWorkspaceLabelChars int

+ PrincipalSendRate SendRate

+ SendRate SendRate

+ func DefaultLimits() Limits

+ type LineReader struct

+ func NewLineReader(r io.Reader) *LineReader

+ func (lr *LineReader) Next() ([]byte, error)

+ type LineWriter struct

+ func NewLineWriter(w io.Writer) *LineWriter

+ func (lw *LineWriter) WriteLine(v any) error

+ type MessageEnvelope struct

+ Body string

+ CreatedAt time.Time

+ DeliveryState string

+ HopCount int

+ Kind string

+ MessageID string

+ ProtocolVersion string

+ RecipientSessionID string

+ ReplyTo *string

+ Sender Sender

+ Summary string

+ TeamRef string

+ func (m *MessageEnvelope) Validate() error

+ type ProfileInfo struct

+ HumanLabel string

+ Name string

+ PrincipalRef string

+ State string

+ TeamName string

+ TeamRef string

+ type ResumeRef struct

+ SessionID string

+ type Retention struct

+ AckedMessageSeconds int

+ ClosedSessionSeconds int

+ UnackedMessageSeconds int

+ func DefaultRetention() Retention

+ type SendRate struct

+ PerHour int

+ PerMinute int

+ type SendRequest struct

+ Body string

+ ForbiddenCreatedAt jsontext.Value

+ ForbiddenHopCount jsontext.Value

+ ForbiddenHumanLabel jsontext.Value

+ ForbiddenPrincipalRef jsontext.Value

+ ForbiddenSender jsontext.Value

+ ForbiddenTeamRef jsontext.Value

+ IdempotencyKey string

+ RecipientSessionID string

+ ReplyTo string

+ SenderSessionID string

+ Summary string

+ func (r *SendRequest) Validate() error

+ type SendResponse struct

+ CreatedAt time.Time

+ Duplicate bool

+ HopCount int

+ MessageID string

+ RecipientSessionID string

+ Status string

+ func (r *SendResponse) Validate() error

+ type Sender struct

+ HumanLabel string

+ PrincipalRef string

+ SessionID string

+ SessionName string

+ type SessionRecord struct

+ Activity string

+ CreatedAt time.Time

+ Harness string

+ HarnessVersion string

+ HumanLabel string

+ Inbound string

+ IsSelf bool

+ LastSeenAt time.Time

+ LeaseUntil time.Time

+ PrincipalRef string

+ SessionDescription *string

+ SessionID string

+ SessionName string

+ State string

+ WorkspaceLabel *string

+ func (s *SessionRecord) Validate() error

+ type SessionRegistration struct

+ Activity string

+ Harness string

+ HarnessVersion string

+ Inbound string

+ LeaseSeconds *int

+ Resume *ResumeRef

+ SessionDescription *string

+ SessionName string

+ WorkspaceLabel *string

+ func (r *SessionRegistration) Validate() error

+ type TeamCreateRequest struct

+ HumanLabel string

+ TeamName string

+ func (r *TeamCreateRequest) Validate() error

+ type TeamCreateResult struct

+ JoinSecret string

+ PrincipalRef string

+ TeamName string

+ TeamRef string

+ func (r *TeamCreateResult) Validate() error

+ type TeamJoinRequest struct

+ Backend jsontext.Value

+ HumanLabel string

+ JoinSecret string

+ func (r *TeamJoinRequest) Validate() error

+ type TeamJoinResult struct

+ PrincipalRef string

+ Rejoined bool

+ TeamName string

+ TeamRef string

+ func (r *TeamJoinResult) Validate() error

+ type TeamLeaveResult struct

+ Left bool

+ PrincipalRef string

+ TeamRef string

+ func (r *TeamLeaveResult) Validate() error

+ type Validator interface

+ Validate func() error

+ type WatchAcked struct

+ Event string

+ MessageIDs []string

+ Unknown []string

+ func (w *WatchAcked) Validate() error

+ type WatchCommand struct

+ Activity *string

+ Inbound *string

+ LeaseSeconds *int

+ MessageIDs []string

+ SessionName *string

+ Type string

+ func (c *WatchCommand) Known() bool

+ func (c *WatchCommand) Validate() error

+ type WatchError struct

+ Error ErrorObject

+ Event string

+ func (w *WatchError) Validate() error

+ type WatchHeartbeatOK struct

+ Event string

+ LeaseUntil time.Time

+ ServerTime time.Time

+ SessionID string

+ State string

+ func (w *WatchHeartbeatOK) Validate() error

+ type WatchMessage struct

+ Event string

+ Message MessageEnvelope

+ func (w *WatchMessage) Validate() error

+ type WatchReady struct

+ Event string

+ Mode string

+ ProtocolVersion string

+ SessionID string

+ func (w *WatchReady) Validate() error

+ type WatchStatus struct

+ Detail string

+ Event string

+ State string

+ func (w *WatchStatus) Known() bool

+ func (w *WatchStatus) Validate() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL