Documentation
¶
Overview ¶
Package transport is an interface for synchronous connection based communication
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var (
DefaultDialTimeout = time.Second * 5
)
Functions ¶
This section is empty.
Types ¶
type DialOption ¶
type DialOption func(*DialOptions)
func WithTimeout ¶
func WithTimeout(d time.Duration) DialOption
Timeout used when dialling the remote side
type DialOptions ¶
type DialOptions struct {
// Tells the transport this is a streaming connection with
// multiple calls to send/recv and that send may not even be called
Stream bool
// Timeout for dialing
Timeout time.Duration
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
type ListenOption ¶
type ListenOption func(*ListenOptions)
type ListenOptions ¶
type Option ¶
type Option func(*Options)
func Codec ¶
Codec sets the codec used for encoding where the transport does not support message headers
type Options ¶
type Options struct {
// Addrs is the list of intermediary addresses to connect to
Addrs []string
// Codec is the codec interface to use where headers are not supported
// by the transport and the entire payload must be encoded
Codec codec.Marshaler
// Secure tells the transport to secure the connection.
// In the case TLSConfig is not specified best effort self-signed
// certs should be used
Secure bool
// TLSConfig to secure the connection. The assumption is that this
// is mTLS keypair
TLSConfig *tls.Config
// Timeout sets the timeout for Send/Recv
Timeout time.Duration
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
type Transport ¶
type Transport interface {
Init(...Option) error
Options() Options
Dial(addr string, opts ...DialOption) (Client, error)
Listen(addr string, opts ...ListenOption) (Listener, error)
String() string
}
Transport is an interface which is used for communication between services. It uses connection based socket send/recv semantics and has various implementations; http, grpc, quic.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package grpc provides a grpc transport
|
Package grpc provides a grpc transport |
|
Package memory is an in-memory transport
|
Package memory is an in-memory transport |
|
Package quic provides a QUIC based transport
|
Package quic provides a QUIC based transport |
Click to show internal directories.
Click to hide internal directories.