conn

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 17, 2023 License: BSD-3-Clause Imports: 31 Imported by: 0

Documentation

Overview

This file was auto-generated by the vanadium vdl tool. Package: conn

Index

Constants

View Source 
const (

	// DefaultBytesBuffered is the default value used for Opts.BytesBuffered
	DefaultBytesBuffered = 1 << 20
	// DefaultMTU is the default value used for Opts.MTU
	DefaultMTU = 1 << 16
	// DefaultChannelTimeout is the default value used for Opts.ChannelTimeout
	DefaultChannelTimeout = 30 * time.Minute
	// DefaultHandshakeTimeout is the default value used for Opts.HandshakeTimeout
	DefaultHandshakeTimeout = time.Minute
)

Variables

View Source 
var (
	ErrMissingSetupOption       = verror.NewID("MissingSetupOption")
	ErrUnexpectedMsg            = verror.NewID("UnexpectedMsg")
	ErrConnectionClosed         = verror.NewID("ConnectionClosed")
	ErrRemoteError              = verror.NewID("RemoteError")
	ErrSend                     = verror.NewID("Send")
	ErrRecv                     = verror.NewID("Recv")
	ErrCounterOverflow          = verror.NewID("CounterOverflow")
	ErrBlessingsFlowClosed      = verror.NewID("BlessingsFlowClosed")
	ErrInvalidChannelBinding    = verror.NewID("InvalidChannelBinding")
	ErrNoPublicKey              = verror.NewID("NoPublicKey")
	ErrDialingNonServer         = verror.NewID("DialingNonServer")
	ErrAcceptorBlessingsMissing = verror.NewID("AcceptorBlessingsMissing")
	ErrDialerBlessingsMissing   = verror.NewID("DialerBlessingsMissing")
	ErrBlessingsNotBound        = verror.NewID("BlessingsNotBound")
	ErrInvalidPeerFlow          = verror.NewID("InvalidPeerFlow")
	ErrChannelTimeout           = verror.NewID("ChannelTimeout")
	ErrCannotDecryptBlessings   = verror.NewID("CannotDecryptBlessings")
	ErrCannotDecryptDischarges  = verror.NewID("CannotDecryptDischarges")
	ErrCannotEncryptBlessings   = verror.NewID("CannotEncryptBlessings")
	ErrCannotEncryptDischarges  = verror.NewID("CannotEncryptDischarges")
	ErrNoCrypter                = verror.NewID("NoCrypter")
	ErrNoPrivateKey             = verror.NewID("NoPrivateKey")
	ErrIdleConnKilled           = verror.NewID("IdleConnKilled")
	ErrRPCVersionMismatch       = verror.NewID("RPCVersionMismatch")
)

These were previously defined in errors.vdl using the ID values below rather than the more conventional Err<Name>.

Functions

func VDLReadBlessingsFlowMessage 

func VDLReadBlessingsFlowMessage(dec vdl.Decoder, x *BlessingsFlowMessage) error

Types

type Blessings 

type Blessings struct {
	Blessings security.Blessings
	BKey      uint64
}

Type definitions ================ Blessings is used to transport blessings between the two ends of a Conn. Since blessings can be large, we try not to send them more than once by associating them with an integer key (BKey). Thereafter we refer to them by their key.

func (Blessings) VDLIsZero 

func (x Blessings) VDLIsZero() bool

func (*Blessings) VDLRead 

func (x *Blessings) VDLRead(dec vdl.Decoder) error

func (Blessings) VDLReflect 

func (Blessings) VDLReflect(struct {
	Name string `vdl:"v.io/x/ref/runtime/internal/flow/conn.Blessings"`
})

func (Blessings) VDLWrite 

func (x Blessings) VDLWrite(enc vdl.Encoder) error

type BlessingsFlowMessage 

type BlessingsFlowMessage interface {
	// Index returns the field index.
	Index() int
	// Interface returns the field value as an interface.
	Interface() interface{}
	// Name returns the field name.
	Name() string
	// VDLReflect describes the BlessingsFlowMessage union type.
	VDLReflect(vdlBlessingsFlowMessageReflect)
	VDLIsZero() bool
	VDLWrite(vdl.Encoder) error
}

BlessingsFlowMessage represents any single field of the BlessingsFlowMessage union type.

BlessingsFlowMessage is used to send either a Blessings, Discharges, EncryptedBlessings or EncryptedDischarges object over the wire.

type BlessingsFlowMessageBlessings 

type BlessingsFlowMessageBlessings struct{ Value Blessings }

BlessingsFlowMessageBlessings represents field Blessings of the BlessingsFlowMessage union type.

func (BlessingsFlowMessageBlessings) Index 

func (x BlessingsFlowMessageBlessings) Index() int

func (BlessingsFlowMessageBlessings) Interface 

func (x BlessingsFlowMessageBlessings) Interface() interface{}

func (BlessingsFlowMessageBlessings) Name 

func (x BlessingsFlowMessageBlessings) Name() string

func (BlessingsFlowMessageBlessings) VDLIsZero 

func (x BlessingsFlowMessageBlessings) VDLIsZero() bool

func (BlessingsFlowMessageBlessings) VDLReflect 

func (x BlessingsFlowMessageBlessings) VDLReflect(vdlBlessingsFlowMessageReflect)

func (BlessingsFlowMessageBlessings) VDLWrite 

func (x BlessingsFlowMessageBlessings) VDLWrite(enc vdl.Encoder) error

type BlessingsFlowMessageDischarges 

type BlessingsFlowMessageDischarges struct{ Value Discharges }

BlessingsFlowMessageDischarges represents field Discharges of the BlessingsFlowMessage union type.

func (BlessingsFlowMessageDischarges) Index 

func (x BlessingsFlowMessageDischarges) Index() int

func (BlessingsFlowMessageDischarges) Interface 

func (x BlessingsFlowMessageDischarges) Interface() interface{}

func (BlessingsFlowMessageDischarges) Name 

func (x BlessingsFlowMessageDischarges) Name() string

func (BlessingsFlowMessageDischarges) VDLIsZero 

func (x BlessingsFlowMessageDischarges) VDLIsZero() bool

func (BlessingsFlowMessageDischarges) VDLReflect 

func (x BlessingsFlowMessageDischarges) VDLReflect(vdlBlessingsFlowMessageReflect)

func (BlessingsFlowMessageDischarges) VDLWrite 

func (x BlessingsFlowMessageDischarges) VDLWrite(enc vdl.Encoder) error

type BlessingsFlowMessageEncryptedBlessings 

type BlessingsFlowMessageEncryptedBlessings struct{ Value EncryptedBlessings }

BlessingsFlowMessageEncryptedBlessings represents field EncryptedBlessings of the BlessingsFlowMessage union type.

func (BlessingsFlowMessageEncryptedBlessings) Index 

func (x BlessingsFlowMessageEncryptedBlessings) Index() int

func (BlessingsFlowMessageEncryptedBlessings) Interface 

func (x BlessingsFlowMessageEncryptedBlessings) Interface() interface{}

func (BlessingsFlowMessageEncryptedBlessings) Name 

func (x BlessingsFlowMessageEncryptedBlessings) Name() string

func (BlessingsFlowMessageEncryptedBlessings) VDLIsZero 

func (x BlessingsFlowMessageEncryptedBlessings) VDLIsZero() bool

func (BlessingsFlowMessageEncryptedBlessings) VDLReflect 

func (x BlessingsFlowMessageEncryptedBlessings) VDLReflect(vdlBlessingsFlowMessageReflect)

func (BlessingsFlowMessageEncryptedBlessings) VDLWrite 

func (x BlessingsFlowMessageEncryptedBlessings) VDLWrite(enc vdl.Encoder) error

type BlessingsFlowMessageEncryptedDischarges 

type BlessingsFlowMessageEncryptedDischarges struct{ Value EncryptedDischarges }

BlessingsFlowMessageEncryptedDischarges represents field EncryptedDischarges of the BlessingsFlowMessage union type.

func (BlessingsFlowMessageEncryptedDischarges) Index 

func (x BlessingsFlowMessageEncryptedDischarges) Index() int

func (BlessingsFlowMessageEncryptedDischarges) Interface 

func (x BlessingsFlowMessageEncryptedDischarges) Interface() interface{}

func (BlessingsFlowMessageEncryptedDischarges) Name 

func (x BlessingsFlowMessageEncryptedDischarges) Name() string

func (BlessingsFlowMessageEncryptedDischarges) VDLIsZero 

func (x BlessingsFlowMessageEncryptedDischarges) VDLIsZero() bool

func (BlessingsFlowMessageEncryptedDischarges) VDLReflect 

func (x BlessingsFlowMessageEncryptedDischarges) VDLReflect(vdlBlessingsFlowMessageReflect)

func (BlessingsFlowMessageEncryptedDischarges) VDLWrite 

func (x BlessingsFlowMessageEncryptedDischarges) VDLWrite(enc vdl.Encoder) error

type BufferingFlow 

type BufferingFlow struct {
	flow.Flow
	// contains filtered or unexported fields
}

BufferingFlow wraps a Flow and buffers all its writes. It writes to the underlying channel when buffering new data would exceed the MTU of the underlying channel or when one of Flush, Close are called. Note that it will never fragment a single payload over multiple writes to the underlying channel but the underlying channel will of course fragment to keep within its mtu boundaries.

func NewBufferingFlow 

func NewBufferingFlow(ctx *context.T, f flow.Flow) *BufferingFlow

NewBufferingFlow creates a new instance of BufferingFlow.

func (*BufferingFlow) Close 

func (b *BufferingFlow) Close() error

Close flushes the already written data and then closes the underlying Flow.

func (*BufferingFlow) Flush 

func (b *BufferingFlow) Flush() error

Flush writes all buffered data to the underlying Flow.

func (*BufferingFlow) Write 

func (b *BufferingFlow) Write(data []byte) (int, error)

Write buffers data until the underlying channel's MTU is reached at which point it will write any buffered data and buffer the newly supplied data.

func (*BufferingFlow) WriteMsg 

func (b *BufferingFlow) WriteMsg(data ...[]byte) (int, error)

WriteMsg buffers data until the underlying channel's MTU is reached at which point it will write any buffered data and buffer the newly supplied data.

func (*BufferingFlow) WriteMsgAndClose 

func (b *BufferingFlow) WriteMsgAndClose(data ...[]byte) (int, error)

WriteMsgAndClose writes all buffered data and closes the underlying Flow.

type Conn 

type Conn struct {
	// contains filtered or unexported fields
}

A Conn acts as a multiplexing encrypted channel that can host Flows.

func NewAccepted 

func NewAccepted(
	ctx *context.T,
	lAuthorizedPeers []security.BlessingPattern,
	conn flow.MsgReadWriteCloser,
	local naming.Endpoint,
	versions version.RPCVersionRange,
	handler FlowHandler,
	opts Opts) (*Conn, error)

NewAccepted accepts a new Conn on the given conn.

NOTE: that the FlowHandler must be called asynchronously since it may 

block until this function returns.

func NewDialed 

func NewDialed(
	ctx *context.T,
	conn flow.MsgReadWriteCloser,
	local, remote naming.Endpoint,
	versions version.RPCVersionRange,
	auth flow.PeerAuthorizer,
	handler FlowHandler,
	opts Opts,
) (c *Conn, names []string, rejected []security.RejectedBlessing, err error)

NewDialed dials a new Conn on the given conn. In the case when it is not dialing a proxy, it can return an error indicating that the context was canceled (verror.ErrCanceled) along with a handshake completes within the specified handshakeTimeout duration. Or put another way, NewDialed will always waut for at most handshakeTimeout duration to complete the handshake even if the context is canceled. The behaviour is different for a proxy connection, in which case a cancelation is immediate and no attempt is made to establish the connection.

func (*Conn) Close 

func (c *Conn) Close(ctx *context.T, err error)

Close shuts down a conn.

func (*Conn) CloseIfIdle 

func (c *Conn) CloseIfIdle(ctx *context.T, idleExpiry time.Duration) bool

CloseIfIdle closes the connection if the conn has been idle for idleExpiry, returning true if it closed it.

func (*Conn) Closed 

func (c *Conn) Closed() <-chan struct{}

Closed returns a channel that will be closed after the Conn is shutdown. After this channel is closed it is guaranteed that all Dial calls will fail with an error and no more flows will be sent to the FlowHandler.

func (*Conn) CommonVersion 

func (c *Conn) CommonVersion() version.RPCVersion

CommonVersion returns the RPCVersion negotiated between the local and remote endpoints.

func (*Conn) DebugString 

func (c *Conn) DebugString() string

func (*Conn) Dial 

func (c *Conn) Dial(ctx *context.T, blessings security.Blessings, discharges []security.Discharge,
	remote naming.Endpoint, channelTimeout time.Duration, sideChannel bool) (flow.Flow, error)

Dial dials a new flow on the Conn.

func (*Conn) EnterLameDuck 

func (c *Conn) EnterLameDuck(ctx *context.T) chan struct{}

EnterLameDuck enters lame duck mode, the returned channel will be closed when the remote end has ack'd or the Conn is closed.

func (*Conn) HasActiveFlows 

func (c *Conn) HasActiveFlows() bool

func (*Conn) IsEncapsulated 

func (c *Conn) IsEncapsulated() bool

func (*Conn) IsIdle 

func (c *Conn) IsIdle(ctx *context.T, idleExpiry time.Duration) bool

func (*Conn) LastUsed 

func (c *Conn) LastUsed() time.Time

LastUsed returns the time at which the Conn had bytes read or written on it.

func (*Conn) LocalBlessings 

func (c *Conn) LocalBlessings() security.Blessings

LocalBlessings returns the local blessings.

func (*Conn) LocalDischarges 

func (c *Conn) LocalDischarges() security.Discharges

LocalDischarges fetches the most recently sent discharges for the local ends blessings.

func (*Conn) LocalEndpoint 

func (c *Conn) LocalEndpoint() naming.Endpoint

LocalEndpoint returns the local vanadium Endpoint

func (*Conn) MTU 

func (c *Conn) MTU() uint64

MTU Returns the maximum transimission unit for the connection in bytes.

func (*Conn) MatchesRID 

func (c *Conn) MatchesRID(ep naming.Endpoint) bool

MatchesRID returns true if the given endpoint matches the routing ID of the remote server. Also returns true if the given ep has the null routing id (in which case it is assumed that any connected server must be the target since nothing has been specified).

func (*Conn) RTT 

func (c *Conn) RTT() time.Duration

RTT returns the round trip time of a message to the remote end. Note the initial estimate of the RTT from the accepted side of a connection my be long because we don't fully factor out certificate verification time. The RTT will be updated with the receipt of every healthCheckResponse, so this overestimate doesn't remain for long when the channel timeout is low.

func (*Conn) RemoteBlessings 

func (c *Conn) RemoteBlessings() security.Blessings

RemoteBlessings returns the remote blessings.

func (*Conn) RemoteDischarges 

func (c *Conn) RemoteDischarges() security.Discharges

RemoteDischarges fetches the most recently received discharges for the remote ends blessings.

func (*Conn) RemoteEndpoint 

func (c *Conn) RemoteEndpoint() naming.Endpoint

RemoteEndpoint returns the remote vanadium Endpoint

func (*Conn) RemoteLameDuck 

func (c *Conn) RemoteLameDuck() bool

RemoteLameDuck returns true if the other end of the connection has announced that it is in lame duck mode indicating that new flows should not be dialed on this conn.

func (*Conn) Status 

func (c *Conn) Status() Status

type Discharges 

type Discharges struct {
	Discharges []security.Discharge
	DKey       uint64
	BKey       uint64
}

Discharges is used to transport discharges between the two ends of a Conn. Since discharges can be large, we try not to send them more than once by associating them with an integer key (DKey). Thereafter we refer to them by their key. Discharges also contains the BKey of the blessings with which the discharges are associated with.

func (Discharges) VDLIsZero 

func (x Discharges) VDLIsZero() bool

func (*Discharges) VDLRead 

func (x *Discharges) VDLRead(dec vdl.Decoder) error

func (Discharges) VDLReflect 

func (Discharges) VDLReflect(struct {
	Name string `vdl:"v.io/x/ref/runtime/internal/flow/conn.Discharges"`
})

func (Discharges) VDLWrite 

func (x Discharges) VDLWrite(enc vdl.Encoder) error

type EncryptedBlessings 

type EncryptedBlessings struct {
	Ciphertexts []bcrypter.WireCiphertext
	BKey        uint64
}

EncryptedBlessings is used to transport encrypted blessings between the two ends of a Conn. The encryption is with respect to a set of blessing patterns that define the set of peers that are allowed to see the blessings. Since encrypted blessings can be large, we try not to send them more than once by associating them with an integer key (BKey). Thereafter we refer to them by their key.

func (EncryptedBlessings) VDLIsZero 

func (x EncryptedBlessings) VDLIsZero() bool

func (*EncryptedBlessings) VDLRead 

func (x *EncryptedBlessings) VDLRead(dec vdl.Decoder) error

func (EncryptedBlessings) VDLReflect 

func (EncryptedBlessings) VDLReflect(struct {
	Name string `vdl:"v.io/x/ref/runtime/internal/flow/conn.EncryptedBlessings"`
})

func (EncryptedBlessings) VDLWrite 

func (x EncryptedBlessings) VDLWrite(enc vdl.Encoder) error

type EncryptedDischarges 

type EncryptedDischarges struct {
	Ciphertexts []bcrypter.WireCiphertext
	DKey        uint64
	BKey        uint64
}

EncryptedDischarges is used to transport encrypted discharges between the two ends of a Conn. The encryption is with respect to a set of blessing patterns that define the set of peers that are allowed to see the discharges. Since discharges can be large, we try not to send them more than once by associating them with an integer key (DKey). Thereafter we refer to them by their key. EncryptedDischarges also contains the BKey of the blessings with which the plaintext discharges are associated with.

func (EncryptedDischarges) VDLIsZero 

func (x EncryptedDischarges) VDLIsZero() bool

func (*EncryptedDischarges) VDLRead 

func (x *EncryptedDischarges) VDLRead(dec vdl.Decoder) error

func (EncryptedDischarges) VDLReflect 

func (EncryptedDischarges) VDLReflect(struct {
	Name string `vdl:"v.io/x/ref/runtime/internal/flow/conn.EncryptedDischarges"`
})

func (EncryptedDischarges) VDLWrite 

func (x EncryptedDischarges) VDLWrite(enc vdl.Encoder) error

type FlowHandler 

type FlowHandler interface {
	// HandleFlow processes an accepted flow.
	HandleFlow(flow.Flow) error
}

A FlowHandler processes accepted flows.

type MTUer 

type MTUer interface {
	MTU() uint64
}

type Opts added in v0.2.0 

type Opts struct {
	// Proxy controls whether the connection is for a proxy or a direct connection.
	Proxy bool

	// HandshakeTimeout is the time allowed for establishing a connection to a peer.
	HandshakeTimeout time.Duration

	// ChannelTimeout is the timeout used for healthchecks.
	ChannelTimeout time.Duration

	// MTU defines the MTU size to use for this connection. This may be reduced
	// if the connection's peer requests a smaller MTU.
	MTU uint64

	// BytesBuffered defines the default number of bytes that can be buffered
	// by a single flow before flow control is invoked.
	BytesBuffered uint64
}

type Status 

type Status int
const (
	Active Status = iota
	EnteringLameDuck
	LameDuckAcknowledged
	Closing
	Closed
)

Note that this is a progression of states that can only go in one direction. We use inequality operators to see how far along in the progression we are, so the order of these is important.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.