summaryrefslogtreecommitdiff
path: root/docs/man/nn_reallocmsg.3compat.adoc
blob: c7a186ae48ab15d736261259ec17abe1df9bd507 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
= nn_reallocmsg(3compat)
//
// 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

nn_reallocmsg - reallocate message (compatible API)

== SYNOPSIS

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

void *nn_reallocmsg(void *old, size_t size);
----

== DESCRIPTION

The `nn_reallocmsg()` reallocates the message _old_, making it of size _size_.

NOTE: This function is provided for API
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
Consider using the relevant <<libnng.3#,modern API>> instead.

On success, the contents of _old_ are copied into the new message
(truncating if appropriate), then _old_ is deallocated, and a pointer
to the new message payload is returned.

On failure, the _old_ message is unchanged, and the value `NULL` is returned
to the caller.

== RETURN VALUES

This function returns a pointer to message buffer space, or `NULL`
on failure.

== ERRORS

[horizontal]
`ENOMEM`:: Insufficient memory is available.
`EINVAL`:: An invalid _size_ was specified.
`ETERM`:: The library is shutting down.

== SEE ALSO

<<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>,
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>