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.
135 lines
4.5 KiB
135 lines
4.5 KiB
6 years ago
|
'\" t
|
||
|
|
.\" Title: ziflist
|
||
|
|
.\" 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 "ZIFLIST" "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"
|
||
|
|
ziflist \- list of network interfaces available on system
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
// This is a stable class, and may not change except for emergencies\&. It
|
||
|
|
// is provided in stable builds\&.
|
||
|
|
// Get a list of network interfaces currently defined on the system
|
||
|
|
CZMQ_EXPORT ziflist_t *
|
||
|
|
ziflist_new (void);
|
||
|
|
|
||
|
|
// Destroy a ziflist instance
|
||
|
|
CZMQ_EXPORT void
|
||
|
|
ziflist_destroy (ziflist_t **self_p);
|
||
|
|
|
||
|
|
// Reload network interfaces from system
|
||
|
|
CZMQ_EXPORT void
|
||
|
|
ziflist_reload (ziflist_t *self);
|
||
|
|
|
||
|
|
// Return the number of network interfaces on system
|
||
|
|
CZMQ_EXPORT size_t
|
||
|
|
ziflist_size (ziflist_t *self);
|
||
|
|
|
||
|
|
// Get first network interface, return NULL if there are none
|
||
|
|
CZMQ_EXPORT const char *
|
||
|
|
ziflist_first (ziflist_t *self);
|
||
|
|
|
||
|
|
// Get next network interface, return NULL if we hit the last one
|
||
|
|
CZMQ_EXPORT const char *
|
||
|
|
ziflist_next (ziflist_t *self);
|
||
|
|
|
||
|
|
// Return the current interface IP address as a printable string
|
||
|
|
CZMQ_EXPORT const char *
|
||
|
|
ziflist_address (ziflist_t *self);
|
||
|
|
|
||
|
|
// Return the current interface broadcast address as a printable string
|
||
|
|
CZMQ_EXPORT const char *
|
||
|
|
ziflist_broadcast (ziflist_t *self);
|
||
|
|
|
||
|
|
// Return the current interface network mask as a printable string
|
||
|
|
CZMQ_EXPORT const char *
|
||
|
|
ziflist_netmask (ziflist_t *self);
|
||
|
|
|
||
|
|
// Return the list of interfaces\&.
|
||
|
|
CZMQ_EXPORT void
|
||
|
|
ziflist_print (ziflist_t *self);
|
||
|
|
|
||
|
|
// Self test of this class\&.
|
||
|
|
CZMQ_EXPORT void
|
||
|
|
ziflist_test (bool verbose);
|
||
|
|
|
||
|
|
Please add \*(Aq@interface\*(Aq section in \*(Aq\&./\&.\&./src/ziflist\&.c\*(Aq\&.
|
||
|
|
.fi
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.sp
|
||
|
|
The ziflist class takes a snapshot of the network interfaces that the system currently supports (this can change arbitrarily, especially on mobile devices)\&. The caller can then access the network interface information using an iterator that works like zlistx\&. Only stores those interfaces with broadcast capability, and ignores the loopback interface\&.
|
||
|
|
.sp
|
||
|
|
Please add \fI@discuss\fR section in \fI\&./\&.\&./src/ziflist\&.c\fR\&.
|
||
|
|
.SH "EXAMPLE"
|
||
|
|
.PP
|
||
|
|
\fBFrom ziflist_test method\fR.
|
||
|
|
.sp
|
||
|
|
.if n \{\
|
||
|
|
.RS 4
|
||
|
|
.\}
|
||
|
|
.nf
|
||
|
|
ziflist_t *iflist = ziflist_new ();
|
||
|
|
assert (iflist);
|
||
|
|
|
||
|
|
size_t items = ziflist_size (iflist);
|
||
|
|
|
||
|
|
if (verbose) {
|
||
|
|
printf ("ziflist: interfaces=%zu\en", ziflist_size (iflist));
|
||
|
|
const char *name = ziflist_first (iflist);
|
||
|
|
while (name) {
|
||
|
|
printf (" \- name=%s address=%s netmask=%s broadcast=%s\en",
|
||
|
|
name, ziflist_address (iflist), ziflist_netmask (iflist), ziflist_broadcast (iflist));
|
||
|
|
name = ziflist_next (iflist);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
ziflist_reload (iflist);
|
||
|
|
assert (items == ziflist_size (iflist));
|
||
|
|
ziflist_destroy (&iflist);
|
||
|
|
.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
|