From 354efc513fdb4096f8830e6c2e3e8f1311303e61 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Wed, 10 Feb 2010 16:18:46 +0100 Subject: Convert documentation to AsciiDoc --- man/man7/zmq_cpp.7 | 103 ----------------------------------------------------- 1 file changed, 103 deletions(-) delete mode 100644 man/man7/zmq_cpp.7 (limited to 'man/man7/zmq_cpp.7') diff --git a/man/man7/zmq_cpp.7 b/man/man7/zmq_cpp.7 deleted file mode 100644 index e3324ba..0000000 --- a/man/man7/zmq_cpp.7 +++ /dev/null @@ -1,103 +0,0 @@ -.TH zmq_cpp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -0MQ C++ API \- interface between 0MQ and C++ applications -.SH SYNOPSIS - -This manual page explains how C++ API maps to underlying C API. To learn about -individual functions and parameters check appropriate C API manual -pages. - -For example, to understand -.IR zmq::socket_t::setsockopt -function check -.BR zmq_setsockopt(3) . - -All 0MQ constants defined with C API are available with C++ API. - -.SH zmq::context_t - -This class encapsulates the functions dealing with initialisation and -termination of 0MQ context. Constructor of the class invokes -.BR zmq_init(3) -while destructor calls -.BR zmq_term(3) . - -.SH zmq::socket_t - -This class encapsulates all the functions to deal with 0MQ sockets. Constructor -calls -.BR zmq_socket(3) , -destructor calls -.BR zmq_close(3) . -Other functions of the class are mapped to C functions with corresponding names. -.IR zmq::socket_t::bind -calls -.BR zmq_bind(3) -etc. - -.SH zmq::message_t - -This class encapsulates -.IR zmq_msg_t -structure and all the C functions that deal with 0MQ messages. -Constructors of the class invoke corresponding initialisation functions ( -.BR zmq_msg_init(3) , -.BR zmq_msg_init_size(3) -and -.BR zmq_msg_init_data(3) , -while destructor invokes -.BR zmq_msg_close(3) -function. - -Remaining functions are mapped to C functions with corresponding names. -For instance, -.IR zmq::message_t::copy -is mapped to -.BR zmq_msg_copy(3) -etc. - -C++ provides an additional function not available with C API. -.IR zmq::message_t::rebuild -is equivalent to calling -.BR zmq_close(3) -followed by -.BR zmq_msg_init(3) , -.BR zmq_msg_init_size (3) -or -.BR zmq_msg_init_data(3) . -It provides a way to reuse existing -.IR zmq::message_t -instances to store different message content. - -.SH zmq::error_t - -All the errors reported using -.IR errno -mechanism in C API are automatically converted to exceptions in C++ API. -.IR zmq::error_t -is derived from -.IR std::exception -and uses -.BR zmq_strerror(3) -function to convert the error code to human-readable string. - -.SH zmq::poll - -.IR zmq::poll -function is a namespaced equivalent of raw C -.BR zmq_poll(3) -function. - -.SH EXAMPLE -.nf -zmq::context_t ctx (1, 1); -zmq::socket_t s (ctx, ZMQ_PUB); -s.connect ("tcp://192.168.0.115:5555"); -zmq::message_t msg (100); -memset (msg.data (), 0, 100); -s.send (msg); -.fi -.SH "SEE ALSO" -.BR zmq(7) -.SH AUTHOR -Martin Sustrik -- cgit v1.2.3