go-micro: github.com/micro/go-micro/transport Index | Files | Directories

package transport

import "github.com/micro/go-micro/transport"

Package transport is an interface for synchronous connection based communication

Index

Package Files

http_proxy.go http_transport.go options.go transport.go

type Client Uses

❖
type Client interface {
    Socket
}

type DialOption Uses

❖
type DialOption func(*DialOptions)

func WithStream Uses

❖
func WithStream() DialOption

Indicates whether this is a streaming connection

func WithTimeout Uses

❖
func WithTimeout(d time.Duration) DialOption

Timeout used when dialling the remote side

type DialOptions Uses

❖
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 Uses

❖
type ListenOption func(*ListenOptions)

type ListenOptions Uses

❖
type ListenOptions struct {

    // Other options for implementations of the interface
    // can be stored in a context
    Context context.Context
}

type Listener Uses

❖
type Listener interface {
    Addr() string
    Close() error
    Accept(func(Socket)) error
}

type Message Uses

❖
type Message struct {
    Header map[string]string
    Body   []byte
}

type Option Uses

❖
type Option func(*Options)

func Addrs Uses

❖
func Addrs(addrs ...string) Option

Addrs to use for transport

func Codec Uses

❖
func Codec(c codec.Marshaler) Option

Codec sets the codec used for encoding where the transport does not support message headers

func Secure Uses

❖
func Secure(b bool) Option

Use secure communication. If TLSConfig is not specified we use InsecureSkipVerify and generate a self signed cert

func TLSConfig Uses

❖
func TLSConfig(t *tls.Config) Option

TLSConfig to be used for the transport.

func Timeout Uses

❖
func Timeout(t time.Duration) Option

Timeout sets the timeout for Send/Recv execution

type Options Uses

❖
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 Socket Uses

❖
type Socket interface {
    Recv(*Message) error
    Send(*Message) error
    Close() error
    Local() string
    Remote() string
}

type Transport Uses

❖
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.

❖
var (
    DefaultTransport Transport = newHTTPTransport()

    DefaultDialTimeout = time.Second * 5
)

func NewTransport Uses

❖
func NewTransport(opts ...Option) Transport

Directories

PathSynopsis
grpcPackage grpc provides a grpc transport
grpc/proto
httpPackage http returns a http2 transport using net/http
memoryPackage memory is an in-memory transport
quicPackage quic provides a QUIC based transport

Package transport imports 22 packages (graph) and is imported by 280 packages. Updated 2020-07-27. Refresh now. Tools for package owners.