api

Documentation

Overview

Majordomo Protocol Client API. Implements the MDP/Worker spec at http://rfc.zeromq.org/spec:7.

Majordomo Protocol Client and Worker API. Implements the MDP/Worker spec at http://rfc.zeromq.org/spec:7.

Majordomo Protocol Worker API. Implements the MDP/Worker spec at http://rfc.zeromq.org/spec:7.

Index

• Constants
• Variables
• type Broker
  • func NewBroker() (broker *Broker, err error)
  • func (b *Broker) Bind(endpoint string) (err error)
  • func (b *Broker) ClientMsg(sender string, msg []string)
  • func (b *Broker) Close() (err error)
  • func (b *Broker) Purge()
  • func (b *Broker) Run(done chan bool)
  • func (b *Broker) ServiceRequire(service_frame string) (service *Service)
  • func (b *Broker) WorkerMsg(sender string, msg []string)
• type Client
  • func NewClient(broker string) (c *Client, err error)
  • func (c *Client) Close() (err error)
  • func (c *Client) ConnectToBroker() (err error)
  • func (c *Client) Recv() (msg []string, err error)
  • func (c *Client) Send(service string, request ...string) (err error)
  • func (c *Client) SetTimeout(timeout time.Duration)
• type Service
  • func (s *Service) Dispatch(msg []string)
• type Worker
  • func NewWorker(broker, service string) (w *Worker, err error)
  • func (w *Worker) Close()
  • func (w *Worker) ConnectToBroker() (err error)
  • func (w *Worker) Recv(reply []string) (msg []string, err error)
  • func (w *Worker) SendToBroker(command string, option string, msg []string) (err error)
  • func (w *Worker) SetHeartbeat(heartbeat time.Duration)
  • func (w *Worker) SetReconnect(reconnect time.Duration)

Constants

const (
	HEARTBEAT_LIVENESS = 3                       // 3-5 is reasonable
	HEARTBEAT_INTERVAL = 2500 * time.Millisecond // msecs
	HEARTBEAT_EXPIRY   = HEARTBEAT_INTERVAL * HEARTBEAT_LIVENESS
)

TODO: get these from config data

const (
	// This is the version of MDP/Client we implement
	MDPC_CLIENT = "MDPC01"

	// This is the version of MDP/Worker we implement
	MDPW_WORKER = "MDPW01"
)

const (
	// MDP/Server commands, as strings
	MDPW_READY = string(iota + 1)
	MDPW_REQUEST
	MDPW_REPLY
	MDPW_HEARTBEAT
	MDPW_DISCONNECT
)

Variables

var (
	MDPS_COMMANDS = map[string]string{
		MDPW_READY:      "READY",
		MDPW_REQUEST:    "REQUEST",
		MDPW_REPLY:      "REPLY",
		MDPW_HEARTBEAT:  "HEARTBEAT",
		MDPW_DISCONNECT: "DISCONNECT",
	}
)

Types

type Broker

type Broker struct {
	Socket *zmq.Socket // Socket for clients & workers

	Waiting     []*brokerWorker // List of waiting workers
	HeartbeatAt time.Time       // When to send HEARTBEAT
	// contains filtered or unexported fields
}

func NewBroker

func NewBroker() (broker *Broker, err error)

func (*Broker) Bind

func (b *Broker) Bind(endpoint string) (err error)

func (*Broker) ClientMsg

func (b *Broker) ClientMsg(sender string, msg []string)

func (*Broker) Close

func (b *Broker) Close() (err error)

func (*Broker) Purge

func (b *Broker) Purge()

func (*Broker) Run

func (b *Broker) Run(done chan bool)

func (*Broker) ServiceRequire

func (b *Broker) ServiceRequire(service_frame string) (service *Service)

func (*Broker) WorkerMsg

func (b *Broker) WorkerMsg(sender string, msg []string)

type Client

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

Majordomo Protocol Client API.

func NewClient

func NewClient(broker string) (c *Client, err error)

func (*Client) Close

func (c *Client) Close() (err error)

func (*Client) ConnectToBroker

func (c *Client) ConnectToBroker() (err error)

Connect or reconnect to broker. In this asynchronous class we use a DEALER socket instead of a REQ socket; this lets us send any number of requests without waiting for a reply.

func (*Client) Recv

func (c *Client) Recv() (msg []string, err error)

func (*Client) Send

func (c *Client) Send(service string, request ...string) (err error)

The send method now just sends one message, without waiting for a reply. Since we're using a DEALER socket we have to send an empty frame at the start, to create the same envelope that the REQ socket would normally make for us:

func (*Client) SetTimeout

func (c *Client) SetTimeout(timeout time.Duration)

Set request timeout.

type Service

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

func (*Service) Dispatch

func (s *Service) Dispatch(msg []string)

type Worker

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

Majordomo Protocol Worker API.

func NewWorker

func NewWorker(broker, service string) (w *Worker, err error)

func (*Worker) Close

func (w *Worker) Close()

func (*Worker) ConnectToBroker

func (w *Worker) ConnectToBroker() (err error)

Connect or reconnect to broker.

func (*Worker) Recv

func (w *Worker) Recv(reply []string) (msg []string, err error)

Send reply, if any, to broker and wait for next request.

func (*Worker) SendToBroker

func (w *Worker) SendToBroker(command string, option string, msg []string) (err error)

Send message to broker.

func (*Worker) SetHeartbeat

func (w *Worker) SetHeartbeat(heartbeat time.Duration)

Set heartbeat delay.

func (*Worker) SetReconnect

func (w *Worker) SetReconnect(reconnect time.Duration)

Set reconnect delay.