abi

type HTTPFetchRequest ¶

type HTTPFetchRequest struct {
	Method  string            `msgpack:"method"`
	URL     string            `msgpack:"url"`
	Headers map[string]string `msgpack:"headers"`
	Body    []byte            `msgpack:"body"`
}

HTTPFetchRequest is sent by the plugin to http_fetch to perform an outbound HTTP call. URL must be absolute; Method defaults to GET when blank. Headers and Body are optional.

func DecodeHTTPFetchRequest(data []byte) (HTTPFetchRequest, error)

type HTTPRequest ¶

type HTTPRequest struct {
	ID      uint64            `msgpack:"id"`
	Method  string            `msgpack:"method"`
	Path    string            `msgpack:"path"`
	Params  map[string]string `msgpack:"params"`
	Query   map[string]string `msgpack:"query"`
	Headers map[string]string `msgpack:"headers"`
	Body    []byte            `msgpack:"body"`
}

HTTPRequest is delivered to the plugin via the step envelope payload when an HTTP request arrives on a route it registered with http_register. ID is allocated by the host and must be echoed back in HTTPResponse.

type HTTPResponse ¶

type HTTPResponse struct {
	ID      uint64            `msgpack:"id"`
	Status  uint32            `msgpack:"status"`
	Headers map[string]string `msgpack:"headers"`
	Body    []byte            `msgpack:"body"`
}

HTTPResponse is produced by the plugin and passed to http_respond, or returned to the plugin by the host as the result of http_fetch. ID is meaningful for inbound responses (matches HTTPRequest.ID); for outbound fetch results it is zero.

func DecodeHTTPResponse(data []byte) (HTTPResponse, error)

type SSEEmitRequest ¶

type SSEEmitRequest struct {
	Path  string `msgpack:"path"`
	ID    string `msgpack:"id,omitempty"`
	Event string `msgpack:"event,omitempty"`
	Data  string `msgpack:"data"`
}

SSEEmitRequest is what the plugin passes to sse_emit. Path selects the SSE route to broadcast on; Data is the event payload. ID and Event are optional SSE fields — ID sets "id:", Event sets "event:" before data.

func DecodeSSEEmitRequest(data []byte) (SSEEmitRequest, error)

type StepEnvelope ¶

type StepEnvelope struct {
	CallNumber uint64
	WallTime   uint64
	Payload    []byte
}

StepEnvelope is the universal header passed to every pulp_step call.

Layout (little-endian, fixed):

call_number  uint64  — how many times step has been called
wall_time    uint64  — unix nanoseconds when Go called step
payload_len  uint32  — length of the following payload bytes
payload      []byte  — trigger data, plugin-defined

func (e StepEnvelope) Encode() []byte

type StepEvent ¶

type StepEvent struct {
	Kind    string             `msgpack:"kind"`
	Payload msgpack.RawMessage `msgpack:"payload"`
}

StepEvent is the outer MessagePack envelope wrapping any event the host delivers to pulp_step. Kind selects which concrete struct Payload decodes to. An empty envelope payload (envelope.Payload == nil) means "no event this step" — the plugin should treat it as a tick and return.

func DecodeStepEvent(data []byte) (StepEvent, error)

type WSClose ¶

type WSClose struct {
	ConnID uint64 `msgpack:"conn_id"`
	Code   uint16 `msgpack:"code"`
	Reason string `msgpack:"reason"`
}

WSClose is the ws.close event — one per disconnect, whether initiated by the client, the plugin, or the host.

type WSCloseRequest ¶

type WSCloseRequest struct {
	ConnID uint64 `msgpack:"conn_id"`
	Code   uint16 `msgpack:"code"`
	Reason string `msgpack:"reason"`
}

WSCloseRequest is what the plugin passes to ws_close.

func DecodeWSCloseRequest(data []byte) (WSCloseRequest, error)

type WSFrame ¶

type WSFrame struct {
	ConnID  uint64 `msgpack:"conn_id"`
	OpCode  uint8  `msgpack:"opcode"`
	Payload []byte `msgpack:"payload"`
}

WSFrame is the ws.frame event — one per inbound frame.

type WSOpen ¶

type WSOpen struct {
	ConnID  uint64            `msgpack:"conn_id"`
	Path    string            `msgpack:"path"`
	Query   map[string]string `msgpack:"query"`
	Headers map[string]string `msgpack:"headers"`
}

WSOpen is the ws.open event — one per accepted connection. ConnID is the host-assigned connection identifier plugins pass back to ws_send and ws_close.

type WSSendRequest ¶

type WSSendRequest struct {
	ConnID  uint64 `msgpack:"conn_id"`
	OpCode  uint8  `msgpack:"opcode"`
	Payload []byte `msgpack:"payload"`
}

WSSendRequest is what the plugin passes to ws_send: which connection, what opcode, the payload bytes.

func DecodeWSSendRequest(data []byte) (WSSendRequest, error)