proto

Documentation

Index

• type ErrorMessage
• type HTTPRequest
• type HTTPResponse
• type Message
• type MessageType
• type TunnelRequest
• type TunnelResponse

Types

type ErrorMessage

type ErrorMessage struct {
	Error string `json:"error"`
}

type HTTPRequest

type HTTPRequest struct {
	Method    string            `json:"method"`
	Path      string            `json:"path"`
	Headers   map[string]string `json:"headers"`
	Body      []byte            `json:"body"`
	RequestId string            `json:"request_id"`
}

type HTTPResponse

type HTTPResponse struct {
	StatusCode int               `json:"status_code"`
	Headers    map[string]string `json:"headers"`
	Body       []byte            `json:"body"`
	RequestId  string            `json:"request_id"`
}

type Message

type Message struct {
	Type    MessageType `json:"type"`
	Payload interface{} `json:"payload,omitempty"`
}

type MessageType

type MessageType string

const (
	MessageTypePing MessageType = "ping"
	MessageTypePong MessageType = "pong"

	MessageTypeTunnelReq  MessageType = "tunnel_req"
	MessageTypeTunnelResp MessageType = "tunnel_resp"

	MessageTypeHTTPRequest  MessageType = "http_request"
	MessageTypeHTTPResponse MessageType = "http_response"

	MessageTypeError MessageType = "error"
)

type TunnelRequest

type TunnelRequest struct {
	// LocalPort is the local port to tunnel and expose to the public internet
	LocalPort   int    `json:"local_port"`
	RequestedId string `json:"requested_id"`
}

type TunnelResponse

type TunnelResponse struct {
	// URL is the public URL of the tunnel to the local port
	URL string `json:"url"`
}