Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseRawPolledCommand ¶
type BaseRawPolledCommand struct {
RequestID string `json:"request_id"`
// ShardToken is an opaque value generated by tunnel-service to associate
// this command with the backend shard or worker responsible for handling
// its lifecycle. Clients MUST treat this value as opaque and MUST echo
// it back when posting the response via the HTTP header
// `X-Tunnel-Shard-Token`. The JSON body of the response MUST NOT contain
// this token.
ShardToken string `json:"shard_token"`
// CommandType is a discriminator for the command payload type.
CommandType CommandType `json:"command_type"`
Channel string `json:"channel,omitempty"`
CreatedAt time.Time `json:"created_at"`
Headers http.Header `json:"headers"`
}
BaseRawPolledCommand contains fields common to all polled command payloads. It is embedded by concrete raw command structs for reuse and to keep JSON field names stable.
type CommandType ¶
type CommandType string
CommandType is a discriminator for different kinds of polled commands.
const ( // CommandTypeJSONRPC indicates a standard JSON-RPC command payload. CommandTypeJSONRPC CommandType = "jsonrpc" // CommandTypeOAuthDiscovery indicates an OAuth discovery command payload. CommandTypeOAuthDiscovery CommandType = "oauth_discovery" // CommandTypeSessionTermination indicates an explicit Streamable HTTP session close. CommandTypeSessionTermination CommandType = "session_termination" )
type PolledCommandEnvelope ¶
type PolledCommandEnvelope struct {
Commands []json.RawMessage `json:"commands"`
}
PolledCommandEnvelope is the top-level container returned by GET /v1/tunnels/{tunnel_id}/poll that groups pending requests for a tunnel.
type RawJSONRPCPolledCommand ¶
type RawJSONRPCPolledCommand struct {
BaseRawPolledCommand
JSONRPC json.RawMessage `json:"jsonrpc"`
}
RawJSONRPCPolledCommand represents a single JSON object returned by GET /v1/tunnels/{tunnel_id}/poll before it is converted into the strongly typed controlplane.PolledCommand interface.
type RawOauthDiscoveryPolledCommand ¶
type RawOauthDiscoveryPolledCommand struct {
BaseRawPolledCommand
}
RawOauthDiscoveryPolledCommand represents an OAuth discovery style command. It extends the base fields and may include discovery-specific attributes.
type RawSessionTerminationPolledCommand ¶
type RawSessionTerminationPolledCommand struct {
BaseRawPolledCommand
}
RawSessionTerminationPolledCommand represents an explicit Streamable HTTP session close.
type ResponsePayloadType ¶
type ResponsePayloadType string
const ( ResponsePayloadJSONRPC ResponsePayloadType = "jsonrpc_response" ResponsePayloadJSONRPCNotify ResponsePayloadType = "jsonrpc_notify" ResponsePayloadNotifyAck ResponsePayloadType = "notify_ack" ResponsePayloadOAuth ResponsePayloadType = "oauth_discovery_response" ResponsePayloadSessionTermination ResponsePayloadType = "session_termination_response" )
type TunnelResponsePayload ¶
type TunnelResponsePayload struct {
RequestID string `json:"request_id"`
Channel string `json:"channel,omitempty"`
JSONResponse json.RawMessage `json:"resp_json,omitempty"`
ResponseHeaders http.Header `json:"resp_headers,omitempty"`
ResponseCode int `json:"resp_code,omitempty"`
ResponseType ResponsePayloadType `json:"resp_type,omitempty"`
}
TunnelResponsePayload mirrors the body posted to POST /v1/tunnels/{tunnel_id}/response when delivering MCP results back to tunnel-service.
Source Files