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.
208 lines
8.8 KiB
208 lines
8.8 KiB
'\" t
|
|
.\" Title: zproc
|
|
.\" 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 "ZPROC" "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"
|
|
zproc \- process configuration and status
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
// This is a draft class, and may change without notice\&. It is disabled in
|
|
// stable builds by default\&. If you use this in applications, please ask
|
|
// for it to be pushed to stable state\&. Use \-\-enable\-drafts to enable\&.
|
|
#ifdef CZMQ_BUILD_DRAFT_API
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns CZMQ version as a single 6\-digit integer encoding the major
|
|
// version (x 10000), the minor version (x 100) and the patch\&.
|
|
CZMQ_EXPORT int
|
|
zproc_czmq_version (void);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns true if the process received a SIGINT or SIGTERM signal\&.
|
|
// It is good practice to use this method to exit any infinite loop
|
|
// processing messages\&.
|
|
CZMQ_EXPORT bool
|
|
zproc_interrupted (void);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns true if the underlying libzmq supports CURVE security\&.
|
|
CZMQ_EXPORT bool
|
|
zproc_has_curve (void);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Return current host name, for use in public tcp:// endpoints\&.
|
|
// If the host name is not resolvable, returns NULL\&.
|
|
// Caller owns return value and must destroy it when done\&.
|
|
CZMQ_EXPORT char *
|
|
zproc_hostname (void);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Move the current process into the background\&. The precise effect
|
|
// depends on the operating system\&. On POSIX boxes, moves to a specified
|
|
// working directory (if specified), closes all file handles, reopens
|
|
// stdin, stdout, and stderr to the null device, and sets the process to
|
|
// ignore SIGHUP\&. On Windows, does nothing\&. Returns 0 if OK, \-1 if there
|
|
// was an error\&.
|
|
CZMQ_EXPORT void
|
|
zproc_daemonize (const char *workdir);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Drop the process ID into the lockfile, with exclusive lock, and
|
|
// switch the process to the specified group and/or user\&. Any of the
|
|
// arguments may be null, indicating a no\-op\&. Returns 0 on success,
|
|
// \-1 on failure\&. Note if you combine this with zsys_daemonize, run
|
|
// after, not before that method, or the lockfile will hold the wrong
|
|
// process ID\&.
|
|
CZMQ_EXPORT void
|
|
zproc_run_as (const char *lockfile, const char *group, const char *user);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Configure the number of I/O threads that ZeroMQ will use\&. A good
|
|
// rule of thumb is one thread per gigabit of traffic in or out\&. The
|
|
// default is 1, sufficient for most applications\&. If the environment
|
|
// variable ZSYS_IO_THREADS is defined, that provides the default\&.
|
|
// Note that this method is valid only before any socket is created\&.
|
|
CZMQ_EXPORT void
|
|
zproc_set_io_threads (size_t io_threads);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Configure the number of sockets that ZeroMQ will allow\&. The default
|
|
// is 1024\&. The actual limit depends on the system, and you can query it
|
|
// by using zsys_socket_limit ()\&. A value of zero means "maximum"\&.
|
|
// Note that this method is valid only before any socket is created\&.
|
|
CZMQ_EXPORT void
|
|
zproc_set_max_sockets (size_t max_sockets);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Set network interface name to use for broadcasts, particularly zbeacon\&.
|
|
// This lets the interface be configured for test environments where required\&.
|
|
// For example, on Mac OS X, zbeacon cannot bind to 255\&.255\&.255\&.255 which is
|
|
// the default when there is no specified interface\&. If the environment
|
|
// variable ZSYS_INTERFACE is set, use that as the default interface name\&.
|
|
// Setting the interface to "*" means "use all available interfaces"\&.
|
|
CZMQ_EXPORT void
|
|
zproc_set_biface (const char *value);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Return network interface to use for broadcasts, or "" if none was set\&.
|
|
CZMQ_EXPORT const char *
|
|
zproc_biface (void);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Set log identity, which is a string that prefixes all log messages sent
|
|
// by this process\&. The log identity defaults to the environment variable
|
|
// ZSYS_LOGIDENT, if that is set\&.
|
|
CZMQ_EXPORT void
|
|
zproc_set_log_ident (const char *value);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Sends log output to a PUB socket bound to the specified endpoint\&. To
|
|
// collect such log output, create a SUB socket, subscribe to the traffic
|
|
// you care about, and connect to the endpoint\&. Log traffic is sent as a
|
|
// single string frame, in the same format as when sent to stdout\&. The
|
|
// log system supports a single sender; multiple calls to this method will
|
|
// bind the same sender to multiple endpoints\&. To disable the sender, call
|
|
// this method with a null argument\&.
|
|
CZMQ_EXPORT void
|
|
zproc_set_log_sender (const char *endpoint);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Enable or disable logging to the system facility (syslog on POSIX boxes,
|
|
// event log on Windows)\&. By default this is disabled\&.
|
|
CZMQ_EXPORT void
|
|
zproc_set_log_system (bool logsystem);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Log error condition \- highest priority
|
|
CZMQ_EXPORT void
|
|
zproc_log_error (const char *format, \&.\&.\&.) CHECK_PRINTF (1);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Log warning condition \- high priority
|
|
CZMQ_EXPORT void
|
|
zproc_log_warning (const char *format, \&.\&.\&.) CHECK_PRINTF (1);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Log normal, but significant, condition \- normal priority
|
|
CZMQ_EXPORT void
|
|
zproc_log_notice (const char *format, \&.\&.\&.) CHECK_PRINTF (1);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Log informational message \- low priority
|
|
CZMQ_EXPORT void
|
|
zproc_log_info (const char *format, \&.\&.\&.) CHECK_PRINTF (1);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Log debug\-level message \- lowest priority
|
|
CZMQ_EXPORT void
|
|
zproc_log_debug (const char *format, \&.\&.\&.) CHECK_PRINTF (1);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Self test of this class\&.
|
|
CZMQ_EXPORT void
|
|
zproc_test (bool verbose);
|
|
|
|
#endif // CZMQ_BUILD_DRAFT_API
|
|
Please add \*(Aq@interface\*(Aq section in \*(Aq\&./\&.\&./src/zproc\&.c\*(Aq\&.
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
zproc \- process configuration and status
|
|
.sp
|
|
Please add \fI@discuss\fR section in \fI\&./\&.\&./src/zproc\&.c\fR\&.
|
|
.SH "EXAMPLE"
|
|
.PP
|
|
\fBFrom zproc_test method\fR.
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
Please add \*(Aq@selftest\*(Aq section in \*(Aq\&./\&.\&./src/zproc\&.c\*(Aq\&.
|
|
.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
|
|
|