package
0.0.0-20180329164818-3cebe5ef9ed5
Repository: https://github.com/clearcontainers/proxy.git
Documentation: pkg.go.dev
# Functions
NewFrame creates a new Frame with type t, operand op and given payload.
NewFrameJSON creates a new Frame with type t, operand op and given payload.
ReadFrame reads a full frame (header and payload) from r.
WriteCommand is a convenience wrapper around WriteFrame to send commands.
WriteFrame writes a frame into w.
WriteNotification is a convenience wrapper around WriteFrame to send notifications.
WriteResponse is a convenience wrapper around WriteFrame to send responses.
WriteStream is a convenience wrapper around WriteFrame to send stream packets.
# Constants
CmdAttachVM attaches to a registered VM.
CmdConnectShim identifies the client as a shim.
CmdDisconnectShim unregisters a shim.
CmdHyper sends a hyperstart command through the proxy.
CmdMax is the number of commands.
CmdRegisterVM registers a new VM/POD.
CmdSignal sends a signal to the process inside the VM.
CmdUnregisterVM unregisters a VM/POD.
NotificationMax is the number of notification types.
NotificationProcessExited is sent to signal a process in the VM has exited.
StreamLog is a stream conveying structured logs messages.
StreamMax is the number of stream types.
StreamStderr is a stream conveying stderr data.
StreamStdin is a stream conveying stdin data.
StreamStdout is a stream conveying stdout data.
TypeCommand is a command from a client to the proxy.
TypeMax is the number of types.
TypeNotification is a notification sent by either the proxy or clients.
TypeResponse is a command response back from the proxy to a client.
TypeStream is a stream of data from a client to the proxy.
Version encodes the proxy protocol version.
# Structs
The AttachVM payload can be used to associate clients to an already known VM.
AttachVMResponse is the result from a successful AttachVM.
ConnectShim identifies a shim against the proxy.
DisconnectShim unregister a shim from the proxy.
ErrorResponse is the payload send in Responses where the Error flag is set.
Frame is the basic communication unit with the proxy.
FrameHeader is the header of a Frame.
The Hyper payload will forward an hyperstart command to hyperstart.
IOResponse is the response data in RegisterVMResponse and AttachVMResponse when the client is asking for I/O tokens from the proxy (NumIOStreams > 0).
LogEntry is the payload for the StreamLog data.
The RegisterVM payload is issued first after connecting to the proxy socket.
RegisterVMResponse is the result from a successful RegisterVM.
A Request is a JSON message sent from a client to the proxy.
A Response is a JSON message sent back from the proxy to a client after a Request has been issued.
Signal is used to send signals to the container process inside the VM.
The UnregisterVM payload does the opposite of what RegisterVM does, indicating to the proxy it should release resources created by RegisterVM for the container identified by containerId.
# Type aliases
Command is the kind of command being sent.
FrameType is the type of frame and is part of the frame header.
Notification is the kind of notification being sent.
Stream is the kind of stream being sent.