protocol.proto

Package : pb

Top

protocol.proto

Table of Contents

Ack

Field Type Label Description
subject string Subject
sequence uint64 Sequence to acknowledge

CloseRequest

Field Type Label Description
clientID string Client name provided to Connect() requests

CloseResponse

Field Type Label Description
error string err string, empty/omitted if no error

ConnectRequest

Field Type Label Description
clientID string Client name/identifier.
heartbeatInbox string Inbox for server initiated heartbeats.

ConnectResponse

Field Type Label Description
pubPrefix string Prefix to use when publishing to this STAN cluster
subRequests string Subject to use for subscription requests
unsubRequests string Subject to use for unsubscribe requests
closeRequests string Subject for closing the stan connection
error string err string, empty/omitted if no error
subCloseRequests string Subject to use for subscription close requests
publicKey string Possibly used to sign acks, etc.

MsgProto

Field Type Label Description
sequence uint64 globally ordered sequence number for the subject's channel
subject string subject
reply string optional reply
data bytes payload
timestamp int64 received timestamp
redelivered bool Flag specifying if the message is being redelivered
cRC32 uint32 optional IEEE CRC32

PubAck

Field Type Label Description
guid string guid
error string err string, empty/omitted if no error

PubMsg

Field Type Label Description
clientID string ClientID
guid string guid
subject string subject
reply string optional reply
data bytes payload
sha256 bytes optional sha256 of data

SubscriptionRequest

Field Type Label Description
clientID string ClientID
subject string Formal subject to subscribe to, e.g. foo.bar
qGroup string Optional queue group
inbox string Inbox subject to deliver messages on
maxInFlight int32 Maximum inflight messages without an ack allowed
ackWaitInSecs int32 Timeout for receiving an ack from the client
durableName string Optional durable name which survives client restarts
startPosition pb.StartPosition Start position
startSequence uint64 Optional start sequence number
startTimeDelta int64 Optional start time

SubscriptionResponse

Field Type Label Description
ackInbox string ackInbox for sending acks
error string err string, empty/omitted if no error

UnsubscribeRequest

Field Type Label Description
clientID string ClientID
subject string subject for the subscription
inbox string Inbox subject to identify subscription
durableName string Optional durable name which survives client restarts

StartPosition

Name Number Description
NewOnly 0
LastReceived 1
TimeDeltaStart 2
SequenceStart 3
First 4