From 2c1d138c774336e846a70f9e5c18f9c23ebb6ff2 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 30 Dec 2017 19:18:49 -0800 Subject: man page updates for 0.2.0 --- man/v0.2.0/nng_pull.html | 605 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 605 insertions(+) create mode 100644 man/v0.2.0/nng_pull.html (limited to 'man/v0.2.0/nng_pull.html') diff --git a/man/v0.2.0/nng_pull.html b/man/v0.2.0/nng_pull.html new file mode 100644 index 00000000..77bae75e --- /dev/null +++ b/man/v0.2.0/nng_pull.html @@ -0,0 +1,605 @@ +--- +version: 0.2.0 +layout: default +--- + + + + + + + + +nng_pull(7) + + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/protocol/pipeline0/pull.h>
+
+int nng_pull0_open(nng_socket *s);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_pull protocol is one half of a pipeline pattern. The other half +is the nng_push(7) protocol.

+
+
+

In the pipeline pattern, pushers distribute messages to pullers. +Each message sent +by a pusher will be sent to one of its peer pullers, +chosen in a round-robin fashion +from the set of connected peers available for receiving. +This property makes this pattern useful in load-balancing scenarios.

+
+
+

Socket Operations

+
+

The nng_pull0_open() call creates a puller socket. This socket +may be used to receive messages, but is unable to send them. Attempts +to send messages will result in NNG_ENOTSUP.

+
+
+

When receiving messages, the nng_pull protocol accepts messages as +they arrive from peers. If two peers both have a message ready, the +order in which messages are handled is undefined.

+
+
+
+

Protocol Versions

+
+

Only version 0 of this protocol is supported. (At the time of writing, +no other versions of this protocol have been defined.)

+
+
+
+

Protocol Options

+
+

The nng_pull protocol has no protocol-specific options.

+
+
+
+

Protocol Headers

+
+

The nng_pull protocol has no protocol-specific headers.

+
+
+
+
+
+

SEE ALSO

+
+
+

nng(7) +nng_push(7)

+
+
+
+
+

COPYRIGHT

+
+
+

Copyright 2017 Garrett D’Amore
+Copyright 2017 Capitar IT Group BV

+
+
+

This document is supplied under the terms of the +MIT License.

+
+
+
+
+ + + -- cgit v1.2.3-70-g09d2