package centrifugal.centrifuge.protocol

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Join, Leave, PresenceResult, Publication

• string user = 1

• string client = 2

• bytes conn_info = 3

• bytes chan_info = 4

Command sent from a client to a server. ProtocolVersion2 uses id and one of the possible request messages.

• uint32 id = 1

  Id of command to let client match replies to commands.

• optional ConnectRequest connect = 4

  ProtocolVersion2 client can send one of the following requests. Server will only take the first non-null request out of these and may return an error if client passed more than one request. We are not using oneof here due to JSON interoperability concerns.

• optional SubscribeRequest subscribe = 5

• optional UnsubscribeRequest unsubscribe = 6

• optional PublishRequest publish = 7

• optional PresenceRequest presence = 8

• optional PresenceStatsRequest presence_stats = 9

• optional HistoryRequest history = 10

• optional PingRequest ping = 11

• optional SendRequest send = 12

• optional RPCRequest rpc = 13

• optional RefreshRequest refresh = 14

• optional SubRefreshRequest sub_refresh = 15

Used in: Push

• string client = 1

• string version = 2

• bytes data = 3

• map<string, SubscribeResult> subs = 4

• bool expires = 5

• uint32 ttl = 6

• uint32 ping = 7

• bool pong = 8

• string session = 9

• string node = 10

• int64 time = 11

  Server time as Unix timestamp in milliseconds (not sent by default).

Used in: Command

• string token = 1

• bytes data = 2

• map<string, SubscribeRequest> subs = 3

• string name = 4

• string version = 5

• map<string, string> headers = 6

Used in: Reply

• string client = 1

• string version = 2

• bool expires = 3

• uint32 ttl = 4

• bytes data = 5

• map<string, SubscribeResult> subs = 6

• uint32 ping = 7

• bool pong = 8

• string session = 9

• string node = 10

• int64 time = 11

  Server time as Unix timestamp in milliseconds (not sent by default).

Used in: Push

• uint32 code = 1

• string reason = 2

• bool reconnect = 3

• string node = 1

• string session = 2

• bytes data = 3

Used in: Reply

• uint32 code = 1

• string message = 2

• bool temporary = 3

Used in: Command

• string channel = 1

• int32 limit = 7

• optional StreamPosition since = 8

• bool reverse = 9

Used in: Reply

• repeated Publication publications = 1

• string epoch = 2

• uint64 offset = 3

Used in: Push

• optional ClientInfo info = 1

Used in: Push

• optional ClientInfo info = 1

Used in: Push

• bytes data = 1

Used in: Command

(message has no fields)

Used in: Reply

(message has no fields)

Used in: Command

• string channel = 1

Used in: Reply

• map<string, ClientInfo> presence = 1

Used in: Command

• string channel = 1

Used in: Reply

• uint32 num_clients = 1

• uint32 num_users = 2

Used in: HistoryResult, Push, SubscribeResult

• bytes data = 4

• optional ClientInfo info = 5

• uint64 offset = 6

• map<string, string> tags = 7

• bool delta = 8

  When set indicates that data in Publication is a delta from previous data.

• int64 time = 9

  Optional time of publication as Unix timestamp milliseconds.

• string channel = 10

  Optional channel name if Publication relates to wildcard subscription.

Used in: Command

• string channel = 1

• bytes data = 2

Used in: Reply

(message has no fields)

Push can be sent to a client as part of Reply in case of bidirectional transport or without additional wrapping in case of unidirectional transports. ProtocolVersion2 uses channel and one of the possible concrete push messages.

Used in: Reply

• string channel = 2

• optional Publication pub = 4

  ProtocolVersion2 server can push one of the following fields to the client. We are not using oneof here due to JSON interoperability concerns.

• optional Join join = 5

• optional Leave leave = 6

• optional Unsubscribe unsubscribe = 7

• optional Message message = 8

• optional Subscribe subscribe = 9

• optional Connect connect = 10

• optional Disconnect disconnect = 11

• optional Refresh refresh = 12

Used in: Command

• bytes data = 1

• string method = 2

Used in: Reply

• bytes data = 1

Used in: Push

• bool expires = 1

• uint32 ttl = 2

Used in: Command

• string token = 1

Used in: Reply

• string client = 1

• string version = 2

• bool expires = 3

• uint32 ttl = 4

Reply sent from a server to a client. ProtocolVersion2 uses id and one of the possible concrete result messages.

• uint32 id = 1

  Id will only be set to a value > 0 for replies to commands. For pushes it will have zero value.

• optional Error error = 2

  Error can only be set in replies to commands. For pushes it will have zero value.

• optional Push push = 4

  ProtocolVersion2 server can send one of the following fields. We are not using oneof here due to JSON interoperability concerns.

• optional ConnectResult connect = 5

• optional SubscribeResult subscribe = 6

• optional UnsubscribeResult unsubscribe = 7

• optional PublishResult publish = 8

• optional PresenceResult presence = 9

• optional PresenceStatsResult presence_stats = 10

• optional HistoryResult history = 11

• optional PingResult ping = 12

• optional RPCResult rpc = 13

• optional RefreshResult refresh = 14

• optional SubRefreshResult sub_refresh = 15

Used in: Command

• bytes data = 1

Used in: HistoryRequest

• uint64 offset = 1

• string epoch = 2

Used in: Command

• string channel = 1

• string token = 2

Used in: Reply

• bool expires = 1

• uint32 ttl = 2

Used in: Push

• bool recoverable = 1

• string epoch = 4

• uint64 offset = 5

• bool positioned = 6

• bytes data = 7

Used in: Command, ConnectRequest

• string channel = 1

• string token = 2

• bool recover = 3

• string epoch = 6

• uint64 offset = 7

• bytes data = 8

• bool positioned = 9

• bool recoverable = 10

• bool join_leave = 11

• string delta = 12

Used in: Connect, ConnectResult, Reply

• bool expires = 1

• uint32 ttl = 2

• bool recoverable = 3

• string epoch = 6

• repeated Publication publications = 7

• bool recovered = 8

• uint64 offset = 9

• bool positioned = 10

• bytes data = 11

• bool was_recovering = 12

• bool delta = 13

Used in: Push

• uint32 code = 2

• string reason = 3

Used in: Command

• string channel = 1

Used in: Reply

(message has no fields)