Documentation ¶
Index ¶
- Variables
- type 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) Request(req protocol.EncodeDecoder) (protocol.EncodeDecoder, error)
- func (c *Client) RequestTo(addr string, req protocol.EncodeDecoder) (protocol.EncodeDecoder, error)
- type ClientConfig
- type RoundRobin
- type Server
- type ServerConfig
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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 (*Client) ClosePool ¶
ClosePool closes the underlying connections in a pool, deletes from Olric's pools map and frees resources.
func (*Client) CreateStream ¶ added in v0.3.0
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) Request ¶
func (c *Client) Request(req protocol.EncodeDecoder) (protocol.EncodeDecoder, error)
Request initiates a request-response cycle to randomly selected host.
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 ClientConfig ¶
type ClientConfig struct { Addrs []string DialTimeout time.Duration KeepAlive time.Duration MinConn int MaxConn int }
ClientConfig configuration parameters of the client.
type RoundRobin ¶
RoundRobin implements quite simple round-robin algorithm to distribute load fairly between servers.
func NewRoundRobin ¶
func NewRoundRobin(addrs []string) *RoundRobin
NewRoundRobin returns a new RoundRobin.
type Server ¶
type Server struct { StartCh 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 ¶
ListenAndServe listens on the TCP network address addr.
func (*Server) SetDispatcher ¶
func (s *Server) SetDispatcher(f func(w, r protocol.EncodeDecoder))
func (*Server) Shutdown ¶
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 ¶ added in v0.3.0
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.