From b6e91e99c40d40a22b0e2f44bab13132000dab36 Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Sat, 25 Jul 2015 05:36:04 +0300 Subject: [PATCH] added forgotten files, added man page; --- debian/libsntl-dev.manpages | 2 + man/Makefile.am | 1 + man/connections_create.3 | 73 ++++++++++++++++++++++++++++++++++++ man/connections_create.3SNTL | 59 ----------------------------- 4 files changed, 76 insertions(+), 59 deletions(-) create mode 100644 debian/libsntl-dev.manpages create mode 100644 man/Makefile.am create mode 100644 man/connections_create.3 delete mode 100644 man/connections_create.3SNTL diff --git a/debian/libsntl-dev.manpages b/debian/libsntl-dev.manpages new file mode 100644 index 0000000..bdba65b --- /dev/null +++ b/debian/libsntl-dev.manpages @@ -0,0 +1,2 @@ +man/sxmsg_rreply.3 +man/connections_create.3 \ No newline at end of file diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..1c30c43 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1 @@ +man_MANS = sxmsg_rreply.3 connections_create.3 diff --git a/man/connections_create.3 b/man/connections_create.3 new file mode 100644 index 0000000..3211f2c --- /dev/null +++ b/man/connections_create.3 @@ -0,0 +1,73 @@ +.TH CONNECTIONS_CREATE 3 "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 +.B connections_create +will create a separate connections set used for handling creation and initialization of the connection links. +.B connections_init +will do the same, but it will take an already preallocated pointer. +.br +.B connections_destroy +will deallocate all related to the connections set, include pointer +.BI ssys +, but +.B connections_free +will not free this pointer consider it will be deallocated by user. +.br +.SH RETURN VALUE +Upon successful completion, the function +.B connections_create +will return a valid pointer to the connections set. +.B connections_init +will return +.B 0 +.br +Otherwise NULL will be returned and errno will be set, or error will be returned, in case of +.B connections_init + use. +.SH ERRORS +.B connections_init +will return, +.B connection_create will set +.B errno +to: +.br +.B ENOMEM +Not enough memory to allocate all required stuff. +.br +.B EINVAL +Returned if invalid pointer given. +.br +.SH BUGS +Not known yet. +.SH EXAMPLE +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.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) diff --git a/man/connections_create.3SNTL b/man/connections_create.3SNTL deleted file mode 100644 index e90c225..0000000 --- a/man/connections_create.3SNTL +++ /dev/null @@ -1,59 +0,0 @@ -.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)