Skip to content

API: timeouts are in seconds #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scottatchley wants to merge 2 commits into
base: master
Choose a base branch
from
Open

API: timeouts are in seconds #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d04bef
API: timeouts are in seconds
scottatchley Jun 7, 2013
1c440f2
API: nanosecond timeouts using a uint64_t
scottatchley Jun 24, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions include/cci.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,6 +739,8 @@ CCI_DECLSPEC int cci_reject(cci_event_t *conn_req);
Multicast connections don't necessarily involve a discrete connection
server, they may be handled by IGMP or other distributed framework.

The timeout is expressed in nanoseconds.

Upon completion, an ...

\param[in] endpoint Local endpoint to use for requested connection.
Expand All @@ -754,7 +756,8 @@ CCI_DECLSPEC int cci_reject(cci_event_t *conn_req);
a connect accepted, rejected, or failed event, and
used to identify the connection in incoming events.
\param[in] flags Currently unused.
\param[in] timeout NULL means forever.
\param[in] timeout The timeout value in nanoseconds. A value of 0 means
forever.

\return CCI_SUCCESS The request is buffered and ready to be sent or
has been sent.
Expand All @@ -767,7 +770,7 @@ CCI_DECLSPEC int cci_reject(cci_event_t *conn_req);
CCI_DECLSPEC int cci_connect(cci_endpoint_t * endpoint, const char *server_uri,
const void *data_ptr, uint32_t data_len,
cci_conn_attribute_t attribute,
const void *context, int flags, const struct timeval *timeout);
const void *context, int flags, uint64_t timeout_ns);

/*!
This constant is the maximum value of data_len passed to cci_connect().
Expand Down Expand Up @@ -1256,11 +1259,12 @@ CCI_DECLSPEC int cci_return_event(cci_event_t * event);
\ingroup opts
*/
typedef enum cci_opt_name {
/*! Default send timeout for all new connections.
/*! Default send timeout for all new connections. The value is in
nanoseconds.

cci_get_opt() and cci_set_opt().

The parameter must point to a uint32_t.
The parameter must point to a uint64_t.
*/
CCI_OPT_ENDPT_SEND_TIMEOUT,

Expand Down Expand Up @@ -1302,7 +1306,7 @@ typedef enum cci_opt_name {
the connection individually using CCI_OPT_CONN_KEEPALIVE_TIMEOUT or
re-arm all connections with this option.

The keepalive timeout is expressed in microseconds. The default is 0
The keepalive timeout is expressed in nanoseconds. The default is 0
(i.e. disabled). Using this option enables the same timeout on all
connections, currently opened and those opened in the future.

Expand All @@ -1312,7 +1316,7 @@ typedef enum cci_opt_name {

cci_get_opt() and cci_set_opt().

The parameter must point to a uint32_t.
The parameter must point to a uint64_t.
*/
CCI_OPT_ENDPT_KEEPALIVE_TIMEOUT,

Expand Down Expand Up @@ -1347,11 +1351,11 @@ typedef enum cci_opt_name {
*/
CCI_OPT_ENDPT_RMA_ALIGN,

/*! Reliable send timeout in microseconds.
/*! Reliable send timeout in nanoseconds.

cci_get_opt() and cci_set_opt().

The parameter must point to a uint32_t.
The parameter must point to a uint64_t.
*/
CCI_OPT_CONN_SEND_TIMEOUT,

Expand All @@ -1362,11 +1366,11 @@ typedef enum cci_opt_name {
application may use it to re-arm a connection that has raised a
CCI_EVENT_KEEPALIVE_TIMEDOUT, to selectively arm only some
connections, or to set a timeout different from the endpoint's
keepalive timeout period.
keepalive timeout period. The value is expressed in nanoseconds.

cci_get_opt() and cci_set_opt().

The parameter must point to a uint32_t.
The parameter must point to a uint64_t.
*/
CCI_OPT_CONN_KEEPALIVE_TIMEOUT
} cci_opt_name_t;
Expand Down