WebSocket configuration

Technical reference of Configuración WebSocket.

This API is used in WebSocket configuration.

Symbols

SymbolClassDescription
WebSocketConfigtypeWebSocketConfig defines a public type of API.
WebSocketHeartbeatConfigtypeWebSocketHeartbeatConfig defines a public type of API.
WebSocketQueueConfigtypeWebSocketQueueConfig defines a public type of API.
WebSocketBufferConfigtypeWebSocketBufferConfig defines a public type of API.
WebSocketCompressionConfigtypeWebSocketCompressionConfig defines a public type of API.

WebSocketConfig

Declaration:

gox
type WebSocketConfig struct {
	Enabled          bool
	HandshakeTimeout time.Duration
	MaxMessageSize   int64
	WriteTimeout     time.Duration
	Heartbeat   WebSocketHeartbeatConfig
	Queue       WebSocketQueueConfig
	Buffers     WebSocketBufferConfig
	Compression WebSocketCompressionConfig
}

WebSocketConfig defines a public type of API.

Fields

FieldTypeDescription
EnabledboolActivate or disable the function.
HandshakeTimeouttime.DurationMaximum waiting time.
MaxMessageSizeint64Size in bytes.
WriteTimeouttime.DurationMaximum waiting time.
HeartbeatWebSocketHeartbeatConfigPublic data associated with Heartbeat.
QueueWebSocketQueueConfigPublic data associated with Queue.
BuffersWebSocketBufferConfigPublic data associated with Buffers.
CompressionWebSocketCompressionConfigPublic data associated with Compression.

WebSocketHeartbeatConfig

Declaration:

gox
type WebSocketHeartbeatConfig struct {
	PingInterval time.Duration
	PongTimeout  time.Duration
}

WebSocketHeartbeatConfig defines a public type of API.

Fields

FieldTypeDescription
PingIntervaltime.DurationTime interval.
PongTimeouttime.DurationMaximum waiting time.

WebSocketQueueConfig

Declaration:

gox
type WebSocketQueueConfig struct {
	MaxMessages int
	MaxBytes    int64
}

WebSocketQueueConfig defines a public type of API.

Fields

FieldTypeDescription
MaxMessagesintPublic data associated with MaxMessages.
MaxBytesint64Number of bytes.

WebSocketBufferConfig

Declaration:

gox
type WebSocketBufferConfig struct {
	ReadSize  int
	WriteSize int
}

WebSocketBufferConfig defines a public type of API.

Fields

FieldTypeDescription
ReadSizeintSize in bytes.
WriteSizeintSize in bytes.

WebSocketCompressionConfig

Declaration:

gox
type WebSocketCompressionConfig struct {
	Enabled bool
	Level   int
}

WebSocketCompressionConfig defines a public type of API.

Fields

FieldTypeDescription
EnabledboolActivate or disable the function.
LevelintPublic data associated with Level.

See also

Next step

Continue with session storage contracts.

Server sessions