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_stream_free(3str)

NAME

nng_stream_free - free byte stream

SYNOPSIS

#include <nng/nng.h>

void nng_stream_free(nng_stream *s);

DESCRIPTION

The nng_stream_free() function closes the byte stream s, and frees the underlying resources associated with it.

If any operations are pending, such as nng_stream_send() or nng_stream_recv(), they will be terminated with an NNG_ECLOSED error condition.

It is important that the application ensure that no further accesses are made to s, as the memory backing it will be reclaimed for other uses.
Closing the connection while data is in transmission will likely lead to loss of that data. There is no automatic linger or flush to ensure that the socket send buffers have completely transmitted.

RETURN VALUES

None.

ERRORS

None.

SEE ALSO