added forgotten files, added man page;

v0.5.xx
Alexander Vdolainen 9 years ago
parent 902530f59a
commit b6e91e99c4

@ -0,0 +1,2 @@
man/sxmsg_rreply.3
man/connections_create.3

@ -0,0 +1 @@
man_MANS = sxmsg_rreply.3 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 <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
.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 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)

@ -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 <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…
Cancel
Save