From 6d553ffab89190e2b5149f3ae08707dca325e0c5 Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Thu, 23 Jul 2015 14:57:15 +0300 Subject: [PATCH] manual skel added; --- man/connections_create.3SNTL | 59 ++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 man/connections_create.3SNTL diff --git a/man/connections_create.3SNTL b/man/connections_create.3SNTL new file mode 100644 index 0000000..e90c225 --- /dev/null +++ b/man/connections_create.3SNTL @@ -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 +.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 +.SH AUTHOR +Alexander Vdolainen (vdo@askele.com)