Skip to content

Commit

Permalink
fixes nanomsg#1536 nng_sendmsg and nng_recvmsg could be faster
Browse files Browse the repository at this point in the history
fixes nanomsg#1535 Desire nng_ctx_sendmsg and nng_ctx_recvmsg
  • Loading branch information
gdamore committed Nov 29, 2021
1 parent 774e937 commit efa7023
Show file tree
Hide file tree
Showing 8 changed files with 325 additions and 51 deletions.
5 changes: 4 additions & 1 deletion docs/man/libnng.3.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= libnng(3)
//
// Copyright 2020 Staysail Systems, Inc. <[email protected]>
// Copyright 2021 Staysail Systems, Inc. <[email protected]>
// Copyright 2018 Capitar IT Group BV <[email protected]>
// Copyright 2019 Devolutions <[email protected]>
// Copyright 2020 Dirac Research <[email protected]>
Expand Down Expand Up @@ -231,7 +231,10 @@ concurrent applications.
|xref:nng_ctx_id.3.adoc[nng_ctx_id()]|get numeric context identifier
|xref:nng_ctx_open.3.adoc[nng_ctx_open()]|create context
|xref:nng_ctx_recv.3.adoc[nng_ctx_recv()]|receive message using context asynchronously
|xref:nng_ctx_recvmsg.3.adoc[nng_ctx_recvmsg()]|receive a message using context
|xref:nng_ctx_send.3.adoc[nng_ctx_send()]|send message using context asynchronously
|xref:nng_ctx_sendmsg.3.adoc[nng_ctx_sendmsg()]|send a message using context

|xref:nng_ctx_set.3.adoc[nng_ctx_set()]|set context option
|xref:nng_ctx_setopt.3.adoc[nng_ctx_setopt()]|set context option
|===
Expand Down
2 changes: 2 additions & 0 deletions docs/man/nng_ctx.5.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ xref:nng_ctx_open.3.adoc[nng_ctx_open(3)],
xref:nng_ctx_get.3.adoc[nng_ctx_get(3)],
xref:nng_ctx_id.3.adoc[nng_ctx_id(3)],
xref:nng_ctx_recv.3.adoc[nng_ctx_recv(3)],
xref:nng_ctx_recvmsg.3.adoc[nng_ctx_recvmsg(3)],
xref:nng_ctx_send.3.adoc[nng_ctx_send(3)],
xref:nng_ctx_sendmsg.3.adoc[nng_ctx_sendmsg(3)],
xref:nng_ctx_set.3.adoc[nng_ctx_set(3)],
xref:nng_dialer.5.adoc[nng_dialer(5)],
xref:nng_listener.5.adoc[nng_listener(5)],
Expand Down
63 changes: 63 additions & 0 deletions docs/man/nng_ctx_recvmsg.3.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
= nng_ctx_recvmsg(3)
//
// Copyright 2021 Staysail Systems, Inc. <[email protected]>
//
// 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_ctx_recvmsg - receive message using socket

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>
int nng_ctx_recvmsg(nng_ctx ctx, nng_msg **msgp, int flags);
----

== DESCRIPTION

The `nng_ctx_recvmsg()` receives a message on context _ctx_, storing the
received message at the location pointed to by _msgp_.

The _flags_ may contain the following value:

`NNG_FLAG_NONBLOCK`::
The function returns immediately, even if no message is available.
Without this flag, the function will wait until a message is receivable
on the context _ctx_, or any configured timer expires.

NOTE: The semantics of what receiving a message means vary from protocol to
protocol, so examination of the protocol documentation is encouraged.

== RETURN VALUES

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

== ERRORS

[horizontal]
`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
`NNG_ECLOSED`:: The context or socket is not open.
`NNG_EINVAL`:: An invalid set of _flags_ was specified.
`NNG_ENOMEM`:: Insufficient memory is available.
`NNG_ENOTSUP`:: The protocol does not support receiving.
`NNG_ESTATE`:: The context cannot receive data in this state.
`NNG_ETIMEDOUT`:: The operation timed out.

== SEE ALSO

[.text-left]
xref:nng_msg_free.3.adoc[nng_msg_free(3)],
xref:nng_ctx_open.3.adoc[nng_ctx_open(3)],
xref:nng_ctx_recv.3.adoc[nng_ctx_recv(3)],
xref:nng_ctx_sendmsg.3.adoc[nng_ctx_sendmsg(3)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_ctx.5.adoc[nng_ctx(5)],
xref:nng.7.adoc[nng(7)]
84 changes: 84 additions & 0 deletions docs/man/nng_ctx_sendmsg.3.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
= nng_ctx_sendmsg(3)
//
// Copyright 2021 Staysail Systems, Inc. <[email protected]>
//
// 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_ctx_sendmsg - send message using context

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>
int nng_ctx_sendmsg(nng_ctx c, nng_msg *msg, int flags);
----

== DESCRIPTION

The `nng_ctx_sendmsg()` sends message _msg_ using the context _ctx_.

If the function returns zero, indicating it has accepted the message for
delivery, then the _msg_ is owned by the socket _s_, and the caller
must not make any further use of it.
The socket will free the message when it is finished.

If the function returns non-zero, then it is the caller's responsibility
to dispose of the _msg_, which may include freeing it, sending it to
another socket, or simply trying again later.

NOTE: The semantics of what sending a message means vary from protocol to
protocol, so examination of the protocol documentation is encouraged.

The _flags_ may contain the following value:

`NNG_FLAG_NONBLOCK`::
The function returns immediately, regardless of whether
the context is able to accept the data or not.
If the context is unable to accept the data (such as if backpressure exists
because the peers are consuming messages too slowly, or no peer is present),
then the function will return with `NNG_EAGAIN`.
If this flag is not specified, then the function will block if such a
condition exists.


NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may
be queues between the sender and the receiver.
Furthermore, there is no guarantee that the message has actually been delivered.
Finally, with some protocols, the semantic is implicitly `NNG_FLAG_NONBLOCK`.

== RETURN VALUES

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

== ERRORS

[horizontal]
`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
`NNG_ECLOSED`:: The context or socket is not open.
`NNG_EINVAL`:: An invalid set of _flags_ was specified.
`NNG_EMSGSIZE`:: The value of _size_ is too large.
`NNG_ENOMEM`:: Insufficient memory is available.
`NNG_ENOTSUP`:: The protocol does not support sending.
`NNG_ESTATE`:: The context cannot send data in this state.
`NNG_ETIMEDOUT`:: The operation timed out.

== SEE ALSO

[.text-left]
xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
xref:nng_ctx_open.3.adoc[nng_ctx_open(3)],
xref:nng_ctx_recvmsg.3.adoc[nng_ctx_recvmsg(3)],
xref:nng_ctx_send.3.adoc[nng_ctx_send(3)],
xref:nng_sendmsg.3.adoc[nng_sendmsg(3)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_msg.5.adoc[nng_msg(5)],
xref:nng_ctx.5.adoc[nng_ctx(5)],
xref:nng.7.adoc[nng(7)]
5 changes: 3 additions & 2 deletions docs/man/nng_recvmsg.3.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= nng_recvmsg(3)
//
// Copyright 2018 Staysail Systems, Inc. <[email protected]>
// Copyright 2021 Staysail Systems, Inc. <[email protected]>
// Copyright 2018 Capitar IT Group BV <[email protected]>
//
// This document is supplied under the terms of the MIT License, a
Expand All @@ -11,7 +11,7 @@

== NAME

nng_recvmsg - recv message
nng_recvmsg - receive a message

== SYNOPSIS

Expand Down Expand Up @@ -67,4 +67,5 @@ xref:nng_msg_free.3.adoc[nng_msg_free(3)],
xref:nng_recv.3.adoc[nng_recv(3)],
xref:nng_sendmsg.3.adoc[nng_sendmsg(3)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_socket.5.adoc[nng_socket(5)],
xref:nng.7.adoc[nng(7)]
14 changes: 12 additions & 2 deletions include/nng/nng.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ extern "C" {
// We use SemVer, and these versions are about the API, and
// may not necessarily match the ABI versions.
#define NNG_MAJOR_VERSION 1
#define NNG_MINOR_VERSION 5
#define NNG_PATCH_VERSION 2
#define NNG_MINOR_VERSION 6
#define NNG_PATCH_VERSION 0
#define NNG_RELEASE_SUFFIX "" // if non-empty, this is a pre-release

// Maximum length of a socket address. This includes the terminating NUL.
Expand Down Expand Up @@ -421,10 +421,20 @@ NNG_DECL int nng_ctx_id(nng_ctx);
// uses a local context instead of the socket global context.
NNG_DECL void nng_ctx_recv(nng_ctx, nng_aio *);

// nng_ctx_recvmsg is allows for receiving a message synchronously using
// a context. It has the same semantics as nng_recvmsg, but operates
// on a context instead of a socket.
NNG_DECL int nng_ctx_recvmsg(nng_ctx, nng_msg **, int);

// nng_ctx_send sends asynchronously. It works like nng_send_aio, but
// uses a local context instead of the socket global context.
NNG_DECL void nng_ctx_send(nng_ctx, nng_aio *);

// nng_ctx_sendmsg is allows for sending a message synchronously using
// a context. It has the same semantics as nng_sendmsg, but operates
// on a context instead of a socket.
NNG_DECL int nng_ctx_sendmsg(nng_ctx, nng_msg *, int);

NNG_DECL int nng_ctx_get(nng_ctx, const char *, void *, size_t *);
NNG_DECL int nng_ctx_get_bool(nng_ctx, const char *, bool *);
NNG_DECL int nng_ctx_get_int(nng_ctx, const char *, int *);
Expand Down
Loading

0 comments on commit efa7023

Please sign in to comment.