3party/libzmq
0
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-27 07:31:03 +08:00
Code Issues Projects Releases Wiki Activity

Problem: Missing doc & unit tests for zmq_poller_fd

Browse Source 
Solution: Add doc & unit tests
This commit is contained in:
jean-airoldie 2019-05-02 05:40:16 -04:00
parent 92eedc5716
commit 19dd8195be
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/zmq_poller.txt
View File

@ -21,11 +21,16 @@ SYNOPSIS
*int zmq_poller_modify_fd (void *'poller', int 'fd', short 'events');* *int zmq_poller_modify_fd (void *'poller', int 'fd', short 'events');*
*int zmq_poller_remove_fd (void *'poller', int 'fd');* *int zmq_poller_remove_fd (void *'poller', int 'fd');*
*int zmq_poller_wait (void *'poller',
zmq_poller_event_t *'event',
long 'timeout');*
*int zmq_poller_wait_all (void *'poller', *int zmq_poller_wait_all (void *'poller',
zmq_poller_event_t *'events', zmq_poller_event_t *'events',
int 'n_events', int 'n_events',
long 'timeout');* long 'timeout');*
*int zmq_poller_fd (void *'poller');*
DESCRIPTION DESCRIPTION
----------- -----------
The _zmq_poller_*_ functions provide a mechanism for applications to multiplex The _zmq_poller_*_ functions provide a mechanism for applications to multiplex
@ -124,6 +129,10 @@ The client does therefore not need to initialize the contents of the events
array before a call to _zmq_poller_wait_all_. It is unspecified whether the array before a call to _zmq_poller_wait_all_. It is unspecified whether the
the remaining elements of 'events' are written to by _zmq_poller_wait_all_. the remaining elements of 'events' are written to by _zmq_poller_wait_all_.
_zmq_poller_fd_ returns the file descriptor associated with the zmq_poller.
The zmq_poller is only guaranteed to have a file descriptor if
at least one thread-safe socket is currently registered.
EVENT TYPES EVENT TYPES
----------- -----------
@ -237,6 +246,9 @@ available.
*EAGAIN*:: *EAGAIN*::
No registered event was signalled before the timeout was reached. No registered event was signalled before the timeout was reached.
On _zmq_poller_fd:
*EINVAL*::
The poller has no associated file descriptor.
EXAMPLE EXAMPLE
------- -------

33
tests/test_poller.cpp
View File

@ -257,6 +257,36 @@ void test_with_valid_poller (extra_poller_func_t extra_func_)
test_context_socket_close (socket); test_context_socket_close (socket);
} }
void test_call_poller_fd_no_signaler ()
{
void *socket = test_context_socket (ZMQ_PAIR);
void *poller = zmq_poller_new ();
TEST_ASSERT_NOT_NULL (poller);
TEST_ASSERT_SUCCESS_ERRNO (
zmq_poller_add (poller, socket, NULL, ZMQ_POLLIN));
TEST_ASSERT_FAILURE_ERRNO (EINVAL, zmq_poller_fd (poller));
test_context_socket_close (socket);
}
void test_call_poller_fd ()
{
void *socket = test_context_socket (ZMQ_CLIENT);
void *poller = zmq_poller_new ();
TEST_ASSERT_NOT_NULL (poller);
TEST_ASSERT_SUCCESS_ERRNO (
zmq_poller_add (poller, socket, NULL, ZMQ_POLLIN));
TEST_ASSERT_SUCCESS_ERRNO (zmq_poller_fd (poller));
test_context_socket_close (socket);
}
void call_poller_wait_null_event_fails (void *poller_) void call_poller_wait_null_event_fails (void *poller_)
{ {
TEST_ASSERT_FAILURE_ERRNO (EFAULT, zmq_poller_wait (poller_, NULL, 0)); TEST_ASSERT_FAILURE_ERRNO (EFAULT, zmq_poller_wait (poller_, NULL, 0));
@ -652,6 +682,9 @@ int main (void)
RUN_TEST (test_call_poller_wait_all_empty_without_timeout_fails); RUN_TEST (test_call_poller_wait_all_empty_without_timeout_fails);
RUN_TEST (test_call_poller_wait_all_empty_with_timeout_fails); RUN_TEST (test_call_poller_wait_all_empty_with_timeout_fails);
RUN_TEST (test_call_poller_fd_no_signaler);
RUN_TEST (test_call_poller_fd);
RUN_TEST (test_poll_basic); RUN_TEST (test_poll_basic);
RUN_TEST (test_poll_fd); RUN_TEST (test_poll_fd);
RUN_TEST (test_poll_client_server); RUN_TEST (test_poll_client_server);