= nng_listener_start(3)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt).  A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//

== NAME

nng_listener_start - start listener

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>

int nng_listener_start(nng_listener l, int flags);
----

== DESCRIPTION

The `nng_listener_start()` function starts the listener _l_.

This causes the listener to bind to the address it was created with,
and to start accepting connections from remote
dialers.
Each new connection results in an xref:nng_pipe.5.adoc[`nng_pipe`] object,
which will be attached to the listener's socket.

The _flags_ argument is ignored, but reserved for future use.

Once a listener has started, it is generally not possible to change
its configuration.

== RETURN VALUES

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

== ERRORS

[horizontal]
`NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener.
`NNG_ESTATE`:: The listener _l_ is already started.

== SEE ALSO

[.text-left]
xref:nng_listen.3.adoc[nng_listen(3)],
xref:nng_listener_create.3.adoc[nng_listener_create(3)]
xref:nng_listener.5.adoc[nng_listener(5)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng.7.adoc[nng(7)]