portforward

Documentation

Index

• Constants
• type Error
• type PortForwardNew
• type PortForwardProtocol

Constants

const (
	// MessageTypePortForwardNew is the message type to start a port-forwarding connection
	// The body MUST contain a PortForwardNew object.
	MessageTypePortForwardNew = "new"
	// MessageTypePortForwardStop is the message type to stop a port-forwarding connection
	MessageTypePortForwardStop = "stop"
	// MessageTypePortForward is the message type for streaming data
	MessageTypePortForward = "forward"
	// MessageTypePortForwardAck is the message type for streaming data acknowledgement
	MessageTypePortForwardAck = "ack"
	// MessageTypeError is returned on internal or protocol errors. The
	// body MUST contain an Error object.
	MessageTypeError = "error"
)

const (
	PortForwardProtocolTCP = "tcp"
	PortForwardProtocolUDP = "udp"
)

Values for the PortForwardProtocol type

const PropertyConnectionID = "connection_id"

PropertyConnectionID is the name of the property holding the connection ID

Types

type Error

type Error struct {
	// The error description, as in "Permission denied while opening a file"
	Error *string `msgpack:"err" json:"error"`
	// Type of message that raised the error
	MessageType *string `msgpack:"msgtype,omitempty" json:"message_type,omitempty"`
}

Error struct is passed in the Body of MsgProto in case the message type is ErrorMessage

type PortForwardNew

type PortForwardNew struct {
	RemoteHost *string              `msgpack:"remote_host" json:"remote_host"`
	RemotePort *uint16              `msgpack:"remote_port" json:"remote_port"`
	Protocol   *PortForwardProtocol `msgpack:"protocol" json:"protocol"`
}

PortForwardNew represents a new port forwarding request

type PortForwardProtocol

type PortForwardProtocol string

PortForwardProtocol stores the protocol