Documentation
¶
Index ¶
- Variables
- type WSCloseConfig
- type WSCloseInput
- type WSCloseOutput
- func (*WSCloseOutput) Descriptor() ([]byte, []int)deprecated
- func (x *WSCloseOutput) GetClosed() bool
- func (x *WSCloseOutput) GetError() string
- func (*WSCloseOutput) ProtoMessage()
- func (x *WSCloseOutput) ProtoReflect() protoreflect.Message
- func (x *WSCloseOutput) Reset()
- func (x *WSCloseOutput) String() string
- type WSSendConfig
- func (*WSSendConfig) Descriptor() ([]byte, []int)deprecated
- func (x *WSSendConfig) GetConnectionId() string
- func (x *WSSendConfig) GetMessage() string
- func (*WSSendConfig) ProtoMessage()
- func (x *WSSendConfig) ProtoReflect() protoreflect.Message
- func (x *WSSendConfig) Reset()
- func (x *WSSendConfig) String() string
- type WSSendInput
- type WSSendOutput
- func (*WSSendOutput) Descriptor() ([]byte, []int)deprecated
- func (x *WSSendOutput) GetError() string
- func (x *WSSendOutput) GetSent() bool
- func (*WSSendOutput) ProtoMessage()
- func (x *WSSendOutput) ProtoReflect() protoreflect.Message
- func (x *WSSendOutput) Reset()
- func (x *WSSendOutput) String() string
- type WSServerConfig
- func (*WSServerConfig) Descriptor() ([]byte, []int)deprecated
- func (x *WSServerConfig) GetAuthRequired() bool
- func (x *WSServerConfig) GetMaxConnections() int32
- func (x *WSServerConfig) GetMaxMessageSize() int64
- func (x *WSServerConfig) GetPath() string
- func (x *WSServerConfig) GetPingInterval() string
- func (x *WSServerConfig) GetPongWait() string
- func (*WSServerConfig) ProtoMessage()
- func (x *WSServerConfig) ProtoReflect() protoreflect.Message
- func (x *WSServerConfig) Reset()
- func (x *WSServerConfig) String() string
- type WebSocketTriggerConfig
Constants ¶
This section is empty.
Variables ¶
var File_websocket_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type WSCloseConfig ¶
type WSCloseConfig struct {
// connection_id is the UUID of the WebSocket connection to close.
ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
// contains filtered or unexported fields
}
WSCloseConfig is the typed config for step.ws_close.
func (*WSCloseConfig) Descriptor
deprecated
func (*WSCloseConfig) Descriptor() ([]byte, []int)
Deprecated: Use WSCloseConfig.ProtoReflect.Descriptor instead.
func (*WSCloseConfig) GetConnectionId ¶
func (x *WSCloseConfig) GetConnectionId() string
func (*WSCloseConfig) ProtoMessage ¶
func (*WSCloseConfig) ProtoMessage()
func (*WSCloseConfig) ProtoReflect ¶
func (x *WSCloseConfig) ProtoReflect() protoreflect.Message
func (*WSCloseConfig) Reset ¶
func (x *WSCloseConfig) Reset()
func (*WSCloseConfig) String ¶
func (x *WSCloseConfig) String() string
type WSCloseInput ¶
type WSCloseInput struct {
Data *structpb.Struct `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
WSCloseInput carries optional runtime overrides for step.ws_close.
func (*WSCloseInput) Descriptor
deprecated
func (*WSCloseInput) Descriptor() ([]byte, []int)
Deprecated: Use WSCloseInput.ProtoReflect.Descriptor instead.
func (*WSCloseInput) GetData ¶
func (x *WSCloseInput) GetData() *structpb.Struct
func (*WSCloseInput) ProtoMessage ¶
func (*WSCloseInput) ProtoMessage()
func (*WSCloseInput) ProtoReflect ¶
func (x *WSCloseInput) ProtoReflect() protoreflect.Message
func (*WSCloseInput) Reset ¶
func (x *WSCloseInput) Reset()
func (*WSCloseInput) String ¶
func (x *WSCloseInput) String() string
type WSCloseOutput ¶
type WSCloseOutput struct {
// closed is true when the connection was found and closed.
Closed bool `protobuf:"varint,1,opt,name=closed,proto3" json:"closed,omitempty"`
// error is populated when the close failed (ws.server not initialized).
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
WSCloseOutput is the result of step.ws_close.
func (*WSCloseOutput) Descriptor
deprecated
func (*WSCloseOutput) Descriptor() ([]byte, []int)
Deprecated: Use WSCloseOutput.ProtoReflect.Descriptor instead.
func (*WSCloseOutput) GetClosed ¶
func (x *WSCloseOutput) GetClosed() bool
func (*WSCloseOutput) GetError ¶
func (x *WSCloseOutput) GetError() string
func (*WSCloseOutput) ProtoMessage ¶
func (*WSCloseOutput) ProtoMessage()
func (*WSCloseOutput) ProtoReflect ¶
func (x *WSCloseOutput) ProtoReflect() protoreflect.Message
func (*WSCloseOutput) Reset ¶
func (x *WSCloseOutput) Reset()
func (*WSCloseOutput) String ¶
func (x *WSCloseOutput) String() string
type WSSendConfig ¶
type WSSendConfig struct {
// connection_id is the UUID of the WebSocket connection to send the message to.
ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
// message is the text payload to deliver.
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
WSSendConfig is the typed config for step.ws_send.
func (*WSSendConfig) Descriptor
deprecated
func (*WSSendConfig) Descriptor() ([]byte, []int)
Deprecated: Use WSSendConfig.ProtoReflect.Descriptor instead.
func (*WSSendConfig) GetConnectionId ¶
func (x *WSSendConfig) GetConnectionId() string
func (*WSSendConfig) GetMessage ¶
func (x *WSSendConfig) GetMessage() string
func (*WSSendConfig) ProtoMessage ¶
func (*WSSendConfig) ProtoMessage()
func (*WSSendConfig) ProtoReflect ¶
func (x *WSSendConfig) ProtoReflect() protoreflect.Message
func (*WSSendConfig) Reset ¶
func (x *WSSendConfig) Reset()
func (*WSSendConfig) String ¶
func (x *WSSendConfig) String() string
type WSSendInput ¶
type WSSendInput struct {
Data *structpb.Struct `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
WSSendInput carries optional runtime overrides for step.ws_send.
func (*WSSendInput) Descriptor
deprecated
func (*WSSendInput) Descriptor() ([]byte, []int)
Deprecated: Use WSSendInput.ProtoReflect.Descriptor instead.
func (*WSSendInput) GetData ¶
func (x *WSSendInput) GetData() *structpb.Struct
func (*WSSendInput) ProtoMessage ¶
func (*WSSendInput) ProtoMessage()
func (*WSSendInput) ProtoReflect ¶
func (x *WSSendInput) ProtoReflect() protoreflect.Message
func (*WSSendInput) Reset ¶
func (x *WSSendInput) Reset()
func (*WSSendInput) String ¶
func (x *WSSendInput) String() string
type WSSendOutput ¶
type WSSendOutput struct {
// sent is true when the message was delivered to the connection.
Sent bool `protobuf:"varint,1,opt,name=sent,proto3" json:"sent,omitempty"`
// error is populated when the send failed (ws.server not initialized, missing connectionId).
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
WSSendOutput is the result of step.ws_send.
func (*WSSendOutput) Descriptor
deprecated
func (*WSSendOutput) Descriptor() ([]byte, []int)
Deprecated: Use WSSendOutput.ProtoReflect.Descriptor instead.
func (*WSSendOutput) GetError ¶
func (x *WSSendOutput) GetError() string
func (*WSSendOutput) GetSent ¶
func (x *WSSendOutput) GetSent() bool
func (*WSSendOutput) ProtoMessage ¶
func (*WSSendOutput) ProtoMessage()
func (*WSSendOutput) ProtoReflect ¶
func (x *WSSendOutput) ProtoReflect() protoreflect.Message
func (*WSSendOutput) Reset ¶
func (x *WSSendOutput) Reset()
func (*WSSendOutput) String ¶
func (x *WSSendOutput) String() string
type WSServerConfig ¶
type WSServerConfig struct {
// path is the HTTP path for the WebSocket upgrade endpoint (default: /ws).
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// max_connections is the maximum number of concurrent WebSocket connections (default: 1000).
MaxConnections int32 `protobuf:"varint,2,opt,name=max_connections,json=maxConnections,proto3" json:"max_connections,omitempty"`
// ping_interval is the duration between server-initiated pings (e.g. "30s"). Default: 30s.
PingInterval string `protobuf:"bytes,3,opt,name=ping_interval,json=pingInterval,proto3" json:"ping_interval,omitempty"`
// pong_wait is the time to wait for a pong reply before disconnecting (e.g. "60s").
PongWait string `protobuf:"bytes,4,opt,name=pong_wait,json=pongWait,proto3" json:"pong_wait,omitempty"`
// max_message_size is the maximum inbound message size in bytes (default: 65536).
MaxMessageSize int64 `protobuf:"varint,5,opt,name=max_message_size,json=maxMessageSize,proto3" json:"max_message_size,omitempty"`
// auth_required, when true, requires an authenticated session before accepting connections.
AuthRequired bool `protobuf:"varint,6,opt,name=auth_required,json=authRequired,proto3" json:"auth_required,omitempty"`
// contains filtered or unexported fields
}
WSServerConfig is the typed config for the ws.server module. Fields mirror the internal wsServerModule config keys (camelCase in YAML).
func (*WSServerConfig) Descriptor
deprecated
func (*WSServerConfig) Descriptor() ([]byte, []int)
Deprecated: Use WSServerConfig.ProtoReflect.Descriptor instead.
func (*WSServerConfig) GetAuthRequired ¶
func (x *WSServerConfig) GetAuthRequired() bool
func (*WSServerConfig) GetMaxConnections ¶
func (x *WSServerConfig) GetMaxConnections() int32
func (*WSServerConfig) GetMaxMessageSize ¶
func (x *WSServerConfig) GetMaxMessageSize() int64
func (*WSServerConfig) GetPath ¶
func (x *WSServerConfig) GetPath() string
func (*WSServerConfig) GetPingInterval ¶
func (x *WSServerConfig) GetPingInterval() string
func (*WSServerConfig) GetPongWait ¶
func (x *WSServerConfig) GetPongWait() string
func (*WSServerConfig) ProtoMessage ¶
func (*WSServerConfig) ProtoMessage()
func (*WSServerConfig) ProtoReflect ¶
func (x *WSServerConfig) ProtoReflect() protoreflect.Message
func (*WSServerConfig) Reset ¶
func (x *WSServerConfig) Reset()
func (*WSServerConfig) String ¶
func (x *WSServerConfig) String() string
type WebSocketTriggerConfig ¶
type WebSocketTriggerConfig struct {
// contains filtered or unexported fields
}
WebSocketTriggerConfig is the typed config for the websocket trigger type. No required fields — the trigger attaches to the global ws.server hub automatically.
func (*WebSocketTriggerConfig) Descriptor
deprecated
func (*WebSocketTriggerConfig) Descriptor() ([]byte, []int)
Deprecated: Use WebSocketTriggerConfig.ProtoReflect.Descriptor instead.
func (*WebSocketTriggerConfig) ProtoMessage ¶
func (*WebSocketTriggerConfig) ProtoMessage()
func (*WebSocketTriggerConfig) ProtoReflect ¶
func (x *WebSocketTriggerConfig) ProtoReflect() protoreflect.Message
func (*WebSocketTriggerConfig) Reset ¶
func (x *WebSocketTriggerConfig) Reset()
func (*WebSocketTriggerConfig) String ¶
func (x *WebSocketTriggerConfig) String() string