This documentation is for the TIP (development tree) of NNG and may represent unreleased changes or functionality that is experimental, and is subject to change before release. The latest released version is v1.3.2. See the documentation for v1.3.2 for the most up-to-date information.

nng_dialer_create(3)

NAME

nng_dialer_create - create dialer

SYNOPSIS

#include <nng/nng.h>

int nng_dialer_create(nng_dialer *dialerp, nng_socket s, const char *url);

DESCRIPTION

The nng_dialer_create() function creates a newly initialized nng_dialer object, associated with socket s, and configured to connect to the address specified by url, and stores a pointer to at the location referenced by dialerp.

Dialers initiate a remote connection to a listener. Upon a successful connection being established, they create a pipe, add it to the socket, and then wait for that pipe to be closed. When the pipe is closed, they will re-initiate the connection. Dialers will also periodically retry a connection automatically if an attempt to connect asynchronously fails.

While it is convenient to think of dialers as clients, the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. For example, a req socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time!

The dialer is not started, but may be further configured with the nng_dialer_setopt() family of functions.

Once it is fully configured, the dialer may be started using the nng_dialer_start() function.

If no specific configuration is required, consider using the simpler nng_dial() function instead.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_EADDRINVAL

An invalid url was specified.

NNG_ECLOSED

The socket s is not open.

NNG_ENOMEM

Insufficient memory is available.

SEE ALSO