transport

Documentation

Index

• Variables
• type Client
  • func NewClient(cc *config.Client) *Client
  • func (c *Client) Close()
  • func (c *Client) ClosePool(addr string)
  • func (c *Client) CreateStream(ctx context.Context, addr string, read chan<- protocol.EncodeDecoder, ...) error
  • func (c *Client) RequestTo(addr string, req protocol.EncodeDecoder) (protocol.EncodeDecoder, error)
• type ConnWithTimeout
  • func NewConnWithTimeout(conn net.Conn, readTimeout, writeTimeout time.Duration) *ConnWithTimeout
  • func (c *ConnWithTimeout) Close() error
  • func (c *ConnWithTimeout) MarkUnusable()
  • func (c *ConnWithTimeout) Read(b []byte) (int, error)
  • func (c *ConnWithTimeout) UnsetDeadline() error
  • func (c *ConnWithTimeout) Write(b []byte) (int, error)
• type Server
  • func NewServer(c *ServerConfig, l *flog.Logger) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) SetDispatcher(f func(w, r protocol.EncodeDecoder))
  • func (s *Server) Shutdown(ctx context.Context) error
• type ServerConfig

Variables

var ErrInvalidMagic = errors.New("invalid magic")

ErrInvalidMagic means that an OBP message is read from the TCP socket but the magic number is not valid.

Types

type Client

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

Client is the client implementation for the internal TCP server. It maintains a connection pool and manages request-response cycle.

func NewClient

func NewClient(cc *config.Client) *Client

NewClient returns a new Client.

func (*Client) Close

func (c *Client) Close()

Close all the connections in the connection pool.

func (*Client) ClosePool

func (c *Client) ClosePool(addr string)

ClosePool closes the underlying connections in a pool, deletes from Olric's pools map and frees resources.

func (*Client) CreateStream

func (c *Client) CreateStream(ctx context.Context, addr string, read chan<- protocol.EncodeDecoder, write <-chan protocol.EncodeDecoder) error

CreateStream creates a new Stream connection which provides a bidirectional communication channel between Olric nodes and clients.

func (*Client) RequestTo

func (c *Client) RequestTo(addr string, req protocol.EncodeDecoder) (protocol.EncodeDecoder, error)

RequestTo initiates a request-response cycle to given host.

type ConnWithTimeout

type ConnWithTimeout struct {
	net.Conn
	// contains filtered or unexported fields
}

ConnWithTimeout denotes a composite type which can used to implement i/o timeout feature for TCP sockets.

func NewConnWithTimeout

func NewConnWithTimeout(conn net.Conn, readTimeout, writeTimeout time.Duration) *ConnWithTimeout

NewConnWithTimeout returns a new ConnWithTimeout instance.

func (*ConnWithTimeout) Close

func (c *ConnWithTimeout) Close() error

Close closes the connection.

func (*ConnWithTimeout) MarkUnusable

func (c *ConnWithTimeout) MarkUnusable()

MarkUnusable() marks the connection not usable any more, to let the pool close it instead of returning it to pool. Wrapper around pool.PoolConn.MarkUnusable

func (*ConnWithTimeout) Read

func (c *ConnWithTimeout) Read(b []byte) (int, error)

Read reads data from the connection and calls net.SetReadDeadline before reading.

func (*ConnWithTimeout) UnsetDeadline

func (c *ConnWithTimeout) UnsetDeadline() error

UnsetDeadline unsets Read/Write deadline directive.

func (*ConnWithTimeout) Write

func (c *ConnWithTimeout) Write(b []byte) (int, error)

Write writes data to the connection and calls net.SetWriteDeadline before writing.

type Server

type Server struct {
	StartCh chan struct{}
	StopCh  chan struct{}
	// contains filtered or unexported fields
}

Server implements a concurrent TCP server.

func NewServer

func NewServer(c *ServerConfig, l *flog.Logger) *Server

NewServer creates and returns a new Server.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe listens on the TCP network address addr.

func (*Server) SetDispatcher

func (s *Server) SetDispatcher(f func(w, r protocol.EncodeDecoder))

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the server without interrupting any active connections. Shutdown works by first closing all open listeners, then closing all idle connections, and then waiting indefinitely for connections to return to idle and then shut down. If the provided context expires before the shutdown is complete, Shutdown returns the context's error, otherwise it returns any error returned from closing the Server's underlying Listener(s).

type ServerConfig

type ServerConfig struct {
	BindAddr        string
	BindPort        int
	KeepAlivePeriod time.Duration
	// GracefulPeriod is useful to close busy connections when you want to shutdown the server.
	GracefulPeriod time.Duration
}

ServerConfig is a composite type to bundle configuration parameters.