import "v.io/v23/flow/message"
const ( // CloseFlag, when set on a Data message, indicates that the flow // should be closed after the payload for that message has been // processed. CloseFlag = 1 << iota // DisableEncryptionFlag, when set on a Data message, causes Append // and Read to behave specially. During Append everything but the // Payload is serialized normally, but the Payload is left for the // caller to deal with. Typically the caller will encrypt the // serialized result and send the unencrypted bytes as a raw follow // on message. Read will expect to not find a payload, and the // caller will typically attach it by examining the next message on // the Conn. DisableEncryptionFlag // SideChannelFlag, when set on a OpenFlow message, marks the Flow // as a side channel. This means that the flow will not be counted // towards the "idleness" of the underlying connection. SideChannelFlag )
data flags.
var ( ErrInvalidMsg = verror.NewID("InvalidMsg") ErrInvalidSetupOption = verror.NewID("InvalidSetupOption") ErrUnknownMsg = verror.NewID("UnknownMsg") ErrMissingBlessings = verror.NewID("MissingBlessings") )
Append serializes the message m and appends it to the given byte slice. The resulting slice is returned, as well as any error that occurs during serialization.
FlowID returns the id of the flow this message is associated with for message types that are bound to a flow, zero otherwise.
NewErrInvalidMsg creates an instance ErrInvalidMsg with the specified parameters which can be access by ParseErrInvalidMessage.
ParseErrInvalidMessage cracks open the parameter list created by NewErrInvalidMsg with appropriate checking. ok will be false if all of the error parameters are not located.
type AckLameDuck struct{}
AckLameDuck is sent in response to an EnterLameDuck message. After this message is received no more OpenFlow messages should arrive.
auth is used to complete the auth handshake.
Data carries encrypted data for a specific flow.
type EnterLameDuck struct{}
EnterLameDuck is sent as notification that the sender is entering lameduck mode. The receiver should stop opening new flows on this connection and respond with an AckLameDuck message.
type HealthCheckRequest struct{}
HealthCheckRequest is periodically sent to test the health of a channel.
type HealthCheckResponse struct{}
HealthCheckResponse messages are sent in response to HealthCheckRequest messages.
type Message interface {
// contains filtered or unexported methods
}
Message is implemented by all low-level messages defined by this package.
Read reads a message contained in the byte slice 'from'.
type MultiProxyRequest struct{}
MultiProxyRequest is sent when a proxy wants to accept connections from another proxy.
type OpenFlow struct { ID uint64 InitialCounters uint64 BlessingsKey, DischargeKey uint64 Flags uint64 Payload [][]byte }
OpenFlow is sent at the beginning of every new flow, it optionally contains payload.
ProxyErrorResponse is send by a proxy in response to a ProxyServerRequest or MultiProxyRequest if the proxy encountered an error while responding to the request. It should be sent in lieu of a ProxyResponse.
func (m *ProxyErrorResponse) String() string
ProxyResponse is sent by a proxy in response to a ProxyServerRequest or MultiProxyRequest. It notifies the server of the endpoints it should publish. Or, it notifies a requesting proxy of the endpoints it accepts connections from.
func (m *ProxyResponse) String() string
type ProxyServerRequest struct{}
ProxyServerRequest is sent when a server wants to listen through a proxy.
Release is sent as flows are read from locally. The counters inform remote writers that there is local buffer space available.
type Setup struct { Versions version.RPCVersionRange PeerNaClPublicKey *[32]byte PeerRemoteEndpoint naming.Endpoint PeerLocalEndpoint naming.Endpoint Mtu uint64 uint64 // contains filtered or unexported fields }
Setup is the first message over the wire. It negotiates protocol version and encryption options for connection. New fields to Setup must be added in order of creation. i.e. the order of the fields should not be changed.
TearDown is sent over the wire before a connection is closed.
Package message imports 8 packages (graph) and is imported by 15 packages. Updated 2020-10-29. Refresh now. Tools for package owners.