manual skel added;
parent
960414e7a9
commit
6d553ffab8
@ -0,0 +1,59 @@
|
||||
.TH CONNECTIONS_CREATE 3SNTL "20 July 2015" "SNTLLv2" "SNTL Library Manual"
|
||||
.SH NAME
|
||||
connections_create \- Allocate and initialize connections system
|
||||
.br
|
||||
connections_init \- Initialize connections system
|
||||
.br
|
||||
connections_destroy \- Destroy connections system
|
||||
.br
|
||||
connections_free \- Free all stuff allocated for connections system
|
||||
.SH SYNOPSIS
|
||||
.B #include <sntl/sntllv2.h>
|
||||
.sp
|
||||
conn_sys_t *connections_create(void);
|
||||
|
||||
int connections_init(conn_sys_t *ssys);
|
||||
|
||||
int connections_destroy(conn_sys_t *ssys);
|
||||
|
||||
int connections_free(conn_sys_t *ssys);
|
||||
|
||||
.br
|
||||
.sp
|
||||
.SH DESCRIPTION
|
||||
.br
|
||||
.SH RETURN VALUE
|
||||
Upon successful completion, the function shall rapidly send a message reply and close
|
||||
the message dialog returning
|
||||
.B SNE_SUCCESS
|
||||
Othrewise other error code will be returned.
|
||||
.SH ERRORS
|
||||
.B SNE_FAILED
|
||||
returns if message has invalid index, channel or message pointer is NULL.
|
||||
.br
|
||||
.B SNE_ESSL
|
||||
returns if write was failed i.e. connection link was broken, or SSL error occurs.
|
||||
.br
|
||||
.B SNE_SUCCESS
|
||||
returns on success.
|
||||
.br
|
||||
.SH BUGS
|
||||
Not known yet.
|
||||
.SH EXAMPLE
|
||||
.B Reply rapidly from the RPC function call.
|
||||
.RS
|
||||
.nf
|
||||
.if t .ft CW
|
||||
char *buf = sxmsg_rapidbuf(msg);
|
||||
int ln = snprintf(buf, MAX_BBUFLEN, "(is-done)");
|
||||
return sxmsg_rreply(msg, str, ln);
|
||||
.SH APPLICATION USAGE
|
||||
This function will be useful in RPC functions required to reply ASAP i.e. for getting some data. It RPC function takes a lot of time it's better to use other functions and postponed message processing.
|
||||
.SH RATIONALE
|
||||
Use for lightweight RPC functions, this method may be used only in RPC call i.e. within SNTL thread context.
|
||||
.SH COPYRIGHT
|
||||
This is a proprietary software. See COPYING for further details.
|
||||
.br
|
||||
(c) Askele Group 2013-2015 <http://askele.com>
|
||||
.SH AUTHOR
|
||||
Alexander Vdolainen (vdo@askele.com)
|
Loading…
Reference in New Issue