edgec

Documentation

Index

• Variables
• type Client
• type ConnectHandler
• type Http
  • func NewHttp(config HttpConfig) *Http
  • func (h *Http) Close() error
  • func (h *Http) GetRequestID() uint64
  • func (h *Http) Send(req *rony.MessageEnvelope, res *rony.MessageEnvelope) error
  • func (h *Http) SendWithDetails(req *rony.MessageEnvelope, res *rony.MessageEnvelope, retry int, ...) (err error)
  • func (h *Http) Start() error
• type HttpConfig
• type MessageHandler
• type Router
• type Websocket
  • func NewWebsocket(config WebsocketConfig) *Websocket
  • func (ws *Websocket) Close() error
  • func (ws *Websocket) ClusterInfo(replicaSets ...uint64) (*rony.Edges, error)
  • func (ws *Websocket) ConnInfo() string
  • func (ws *Websocket) GetRequestID() uint64
  • func (ws *Websocket) Send(req, res *rony.MessageEnvelope) (err error)
  • func (ws *Websocket) SendTo(req, res *rony.MessageEnvelope, serverID string) error
  • func (ws *Websocket) SendWithDetails(req, res *rony.MessageEnvelope, retry int, timeout time.Duration, ...) error
  • func (ws *Websocket) Start() error
• type WebsocketConfig

Variables

var (
	ErrNoConnection      = fmt.Errorf("no connection")
	ErrNoHost            = fmt.Errorf("no host")
	ErrTimeout           = fmt.Errorf("time out")
	ErrReplicaMaster     = fmt.Errorf("leader redirect")
	ErrReplicaSetSession = fmt.Errorf("replica redirect session")
	ErrReplicaSetRequest = fmt.Errorf("replica redirect request")
	ErrUnknownResponse   = fmt.Errorf("unknown response")
)

Types

type Client

type Client interface {
	Send(req, res *rony.MessageEnvelope) error
	Close() error
	GetRequestID() uint64
}

type ConnectHandler

type ConnectHandler func(c *Websocket)

type Http

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

Http connects to edge servers with HTTP transport.

func NewHttp

func NewHttp(config HttpConfig) *Http

func (*Http) Close

func (h *Http) Close() error

Close implements Client interface

func (*Http) GetRequestID

func (h *Http) GetRequestID() uint64

GetRequestID implements Client interface

func (*Http) Send

func (h *Http) Send(req *rony.MessageEnvelope, res *rony.MessageEnvelope) error

func (*Http) SendWithDetails

func (h *Http) SendWithDetails(
	req *rony.MessageEnvelope, res *rony.MessageEnvelope,
	retry int, timeout time.Duration,
) (err error)

func (*Http) Start

func (h *Http) Start() error

type HttpConfig

type HttpConfig struct {
	Name            string
	SeedHostPort    string
	HeaderFunc      func() map[string]string
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	ContextTimeout  time.Duration
	RequestMaxRetry int
	Router          Router
	Secure          bool
}

HttpConfig holds the configurations for the Http client.

type MessageHandler

type MessageHandler func(m *rony.MessageEnvelope)

type Router

type Router interface {
	UpdateRoute(req *rony.MessageEnvelope, replicaSet uint64)
	GetRoute(req *rony.MessageEnvelope) (replicaSet uint64)
}

type Websocket

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

Websocket client which could handle multiple connections

func NewWebsocket

func NewWebsocket(config WebsocketConfig) *Websocket

func (*Websocket) Close

func (ws *Websocket) Close() error

func (*Websocket) ClusterInfo

func (ws *Websocket) ClusterInfo(replicaSets ...uint64) (*rony.Edges, error)

func (*Websocket) ConnInfo

func (ws *Websocket) ConnInfo() string

func (*Websocket) GetRequestID

func (ws *Websocket) GetRequestID() uint64

func (*Websocket) Send

func (ws *Websocket) Send(req, res *rony.MessageEnvelope) (err error)

func (*Websocket) SendTo

func (ws *Websocket) SendTo(req, res *rony.MessageEnvelope, serverID string) error

func (*Websocket) SendWithDetails

func (ws *Websocket) SendWithDetails(
	req, res *rony.MessageEnvelope, retry int, timeout time.Duration, serverID string,
) error

func (*Websocket) Start

func (ws *Websocket) Start() error

type WebsocketConfig

type WebsocketConfig struct {
	SeedHostPort string
	IdleTimeout  time.Duration
	DialTimeout  time.Duration
	// Handler must not block in function because other incoming messages might get blocked.
	// This handler must returns quickly and pass a deep copy of the MessageEnvelope to other
	// routines.
	Handler    MessageHandler
	HeaderFunc func() map[string]string
	Secure     bool
	// RequestMaxRetry is the maximum number client sends a request if any network layer error occurs
	RequestMaxRetry int
	// RequestTimeout is the timeout for each individual request on each try.
	RequestTimeout time.Duration
	// ContextTimeout is the amount that Send function will wait until times out. This includes all the retries.
	ContextTimeout time.Duration
	// Router is an optional parameter which give more control over selecting the target host based on each request.
	Router Router
	// OnConnect will be called everytime the websocket connection is established.
	OnConnect ConnectHandler
}

WebsocketConfig holds the configs for the Websocket client