zmq.Poller methods

 

 

method

description and examples

variables data type

register()

registers a socket for polling for events:

 

CALL poller_name.Register(socket_name, "event_01", "event_02", "event_03")

 

Depending on the number of the parameters specified, registers a socket for:

  • for polling on all events:

 

CALL poller_name.Register(socket_name)

 

  • for polling on the specified event:

 

CALL poller_name.Register(socket_name, "event_01"")

 

  • for polling on two specified events:

 

CALL poller_name.Register(socket_name, "event_01", "event_02")

 

  • for polling on three specified events:

 

CALL poller_name.Register(socket_name, "event_01", "event_02", "event_03")

 

ZMQ.Poller

ZMQ.Socket for the parameter

STRING for the event

poll()

issues a polling call:

 

CALL poller_name.Poll()

CALL poller_name.Poll(timeout)

 

When the timeout parameter is specified, the method will wait for the event to occur within the specified timeout (in milliseconds):

 

CALL poller_name.Poll(15)

 

INTEGER

polerr()

checks whether the ZMQ.POLLERR event have occurred for the specified element:

 

CALL poller_name.Pollerr(INT)

 

BOOLEAN

INTEGER

pollin()

checks whether the ZMQ.POLLIN event have occurred for the specified element:

 

CALL poller_name.Pollin(INT)

 

BOOLEAN

INTEGER

pollout()

checks whether the ZMQ.POLLOUT event have occurred for the specified element:

 

CALL poller_name.Pollout(INT)

 

BOOLEAN

INTEGER

 

Possible events are:

 

ZMQ.POLLERR

Any kind of error condition occurred in a socket.

 

ZMQ.POLLIN

At least, one byte of data has come to the socket and can be read without blocking.

 

ZMQ.POLLOUT

At least, one byte of data was sent to the socket and can be written without blocking.