Skip to content

Latest commit

 

History

History
20 lines (11 loc) · 1.99 KB

connect.md

File metadata and controls

20 lines (11 loc) · 1.99 KB
description
Message to authenticate and negotiate connection parameters.

Connect

Request

A Connect message MUST be sent from the client to the server to authenticate and negotiate the connection parameters. This message MUST be the first one after establishing the connection. If any other message or data is received, the server MUST close the connection immediately.

Header

FieldValueDescription
Message Type0x03Connect
Message SizevarintRemaining Message Length

Body

NameFieldTypeMandatoryDescription
Stream Id0x01trueConnect Stream identifier.
Parameters0x02falseConnect parameters, that can be used to identify the authentication type.
Payload0x03trueAuthentication payload to log-in with the server.
Keep Alive0x04falseEstablish a Keep Alive interval in seconds. Default keep-alive interval depends on server implementation.
Encoding0x05falseDefines the encoding mechanism that will be used when sending any values
Version0x06falseSpecifies the protocol version to be used.

Response