You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
158 lines
5.0 KiB
158 lines
5.0 KiB
5 years ago
|
'\" t
|
||
|
|
.\" Title: zmonitor
|
||
|
|
.\" Author: [see the "AUTHORS" section]
|
||
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
||
|
|
.\" Date: 12/31/2016
|
||
|
|
.\" Manual: CZMQ Manual
|
||
|
|
.\" Source: CZMQ 4.0.2
|
||
|
|
.\" Language: English
|
||
|
|
.\"
|
||
|
|
.TH "ZMONITOR" "3" "12/31/2016" "CZMQ 4\&.0\&.2" "CZMQ Manual"
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * Define some portability stuff
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.\" http://bugs.debian.org/507673
|
||
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * set default formatting
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" disable hyphenation
|
||
|
|
.nh
|
||
|
|
.\" disable justification (adjust text to left margin only)
|
||
|
|
.ad l
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * MAIN CONTENT STARTS HERE *
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.SH "NAME"
|
||
|
|
zmonitor \- socket event monitor
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
// Create new zmonitor actor instance to monitor a zsock_t socket:
|
||
|
|
//
|
||
|
|
// zactor_t *monitor = zactor_new (zmonitor, mysocket);
|
||
|
|
//
|
||
|
|
// Destroy zmonitor instance\&.
|
||
|
|
//
|
||
|
|
// zactor_destroy (&monitor);
|
||
|
|
//
|
||
|
|
// Enable verbose logging of commands and activity\&.
|
||
|
|
//
|
||
|
|
// zstr_send (monitor, "VERBOSE");
|
||
|
|
//
|
||
|
|
// Listen to monitor event type (zero or types, ending in NULL):
|
||
|
|
// zstr_sendx (monitor, "LISTEN", type, \&.\&.\&., NULL);
|
||
|
|
//
|
||
|
|
// Events:
|
||
|
|
// CONNECTED
|
||
|
|
// CONNECT_DELAYED
|
||
|
|
// CONNECT_RETRIED
|
||
|
|
// LISTENING
|
||
|
|
// BIND_FAILED
|
||
|
|
// ACCEPTED
|
||
|
|
// ACCEPT_FAILED
|
||
|
|
// CLOSED
|
||
|
|
// CLOSE_FAILED
|
||
|
|
// DISCONNECTED
|
||
|
|
// MONITOR_STOPPED
|
||
|
|
// ALL
|
||
|
|
//
|
||
|
|
// Start monitor; after this, any further LISTEN commands are ignored\&.
|
||
|
|
//
|
||
|
|
// zstr_send (monitor, "START");
|
||
|
|
// zsock_wait (monitor);
|
||
|
|
//
|
||
|
|
// Receive next monitor event:
|
||
|
|
//
|
||
|
|
// zmsg_t *msg = zmsg_recv (monitor);
|
||
|
|
//
|
||
|
|
// This is the zmonitor constructor as a zactor_fn; the argument can be
|
||
|
|
// a zactor_t, zsock_t, or libzmq void * socket:
|
||
|
|
CZMQ_EXPORT void
|
||
|
|
zmonitor (zsock_t *pipe, void *sock);
|
||
|
|
|
||
|
|
// Selftest
|
||
|
|
CZMQ_EXPORT void
|
||
|
|
zmonitor_test (bool verbose);
|
||
|
|
Please add \*(Aq@interface\*(Aq section in \*(Aq\&./\&.\&./src/zmonitor\&.c\*(Aq\&.
|
||
|
|
.fi
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.sp
|
||
|
|
The zmonitor actor provides an API for obtaining socket events such as connected, listen, disconnected, etc\&. Socket events are only available for sockets connecting or bound to ipc:// and tcp:// endpoints\&.
|
||
|
|
.sp
|
||
|
|
This class wraps the ZMQ socket monitor API, see zmq_socket_monitor for details\&. Works on all versions of libzmq from 3\&.2 onwards\&. This class replaces zproxy_v2, and is meant for applications that use the CZMQ v3 API (meaning, zsock)\&.
|
||
|
|
.SH "EXAMPLE"
|
||
|
|
.PP
|
||
|
|
\fBFrom zmonitor_test method\fR.
|
||
|
|
.sp
|
||
|
|
.if n \{\
|
||
|
|
.RS 4
|
||
|
|
.\}
|
||
|
|
.nf
|
||
|
|
zsock_t *client = zsock_new (ZMQ_DEALER);
|
||
|
|
assert (client);
|
||
|
|
zactor_t *clientmon = zactor_new (zmonitor, client);
|
||
|
|
assert (clientmon);
|
||
|
|
if (verbose)
|
||
|
|
zstr_sendx (clientmon, "VERBOSE", NULL);
|
||
|
|
zstr_sendx (clientmon, "LISTEN", "LISTENING", "ACCEPTED", NULL);
|
||
|
|
zstr_sendx (clientmon, "START", NULL);
|
||
|
|
zsock_wait (clientmon);
|
||
|
|
|
||
|
|
zsock_t *server = zsock_new (ZMQ_DEALER);
|
||
|
|
assert (server);
|
||
|
|
zactor_t *servermon = zactor_new (zmonitor, server);
|
||
|
|
assert (servermon);
|
||
|
|
if (verbose)
|
||
|
|
zstr_sendx (servermon, "VERBOSE", NULL);
|
||
|
|
zstr_sendx (servermon, "LISTEN", "CONNECTED", "DISCONNECTED", NULL);
|
||
|
|
zstr_sendx (servermon, "START", NULL);
|
||
|
|
zsock_wait (servermon);
|
||
|
|
|
||
|
|
// Allow a brief time for the message to get there\&.\&.\&.
|
||
|
|
zmq_poll (NULL, 0, 200);
|
||
|
|
|
||
|
|
// Check client is now listening
|
||
|
|
int port_nbr = zsock_bind (client, "tcp://127\&.0\&.0\&.1:*");
|
||
|
|
assert (port_nbr != \-1);
|
||
|
|
s_assert_event (clientmon, "LISTENING");
|
||
|
|
|
||
|
|
// Check server connected to client
|
||
|
|
zsock_connect (server, "tcp://127\&.0\&.0\&.1:%d", port_nbr);
|
||
|
|
s_assert_event (servermon, "CONNECTED");
|
||
|
|
|
||
|
|
// Check client accepted connection
|
||
|
|
s_assert_event (clientmon, "ACCEPTED");
|
||
|
|
|
||
|
|
zactor_destroy (&clientmon);
|
||
|
|
zactor_destroy (&servermon);
|
||
|
|
zsock_destroy (&client);
|
||
|
|
zsock_destroy (&server);
|
||
|
|
#endif
|
||
|
|
.fi
|
||
|
|
.if n \{\
|
||
|
|
.RE
|
||
|
|
.\}
|
||
|
|
.sp
|
||
|
|
.SH "AUTHORS"
|
||
|
|
.sp
|
||
|
|
The czmq manual was written by the authors in the AUTHORS file\&.
|
||
|
|
.SH "RESOURCES"
|
||
|
|
.sp
|
||
|
|
Main web site: \m[blue]\fB\%\fR\m[]
|
||
|
|
.sp
|
||
|
|
Report bugs to the email <\m[blue]\fBzeromq\-dev@lists\&.zeromq\&.org\fR\m[]\&\s-2\u[1]\d\s+2>
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.sp
|
||
|
|
Copyright (c) the Contributors as noted in the AUTHORS file\&. This file is part of CZMQ, the high\-level C binding for 0MQ: http://czmq\&.zeromq\&.org\&. This Source Code Form is subject to the terms of the Mozilla Public License, v\&. 2\&.0\&. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla\&.org/MPL/2\&.0/\&. LICENSE included with the czmq distribution\&.
|
||
|
|
.SH "NOTES"
|
||
|
|
.IP " 1." 4
|
||
|
|
zeromq-dev@lists.zeromq.org
|
||
|
|
.RS 4
|
||
|
|
\%mailto:zeromq-dev@lists.zeromq.org
|
||
|
|
.RE
|