public/libsxmp
public/libsxmp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixes manpages;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-11-13 15:04:19 +02:00
parent 78d6226a43
commit 67f409dd99
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/sxchannel_open.3
View File

@ -16,7 +16,7 @@ int sxchannel_close(sxchnl_t *channel);
.B sxchannel_open .B sxchannel_open
will open RPC channel using will open RPC channel using
.B co .B co
connection link with specified type via hub link with specified type determined by
.B type .B type
that available/permitted to use for current peer. that available/permitted to use for current peer.
.br .br

18
man/sxhub_create.3
View File

@ -1,12 +1,12 @@
.TH SXHUB_CREATE 3 "20 July 2015" "SXMP" "SXMP Library Manual" .TH SXHUB_CREATE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME .SH NAME
sxhub_create \- Allocate and initialize connections system sxhub_create \- Allocate and initialize links hub
.br .br
sxhub_init \- Initialize connections system sxhub_init \- Initialize links hub
.br .br
sxhub_destroy \- Destroy connections system sxhub_destroy \- Destroy links hub
.br .br
sxhub_free \- Free all stuff allocated for connections system sxhub_free \- Free all stuff allocated for hub
.SH SYNOPSIS .SH SYNOPSIS
.B #include <sxmp/sxmp.h> .B #include <sxmp/sxmp.h>
.sp .sp
@ -22,12 +22,12 @@ int sxhub_free(sxhub_t *ssys);
.sp .sp
.SH DESCRIPTION .SH DESCRIPTION
.B sxhub_create .B sxhub_create
will create a separate connections set used for handling creation and initialization of the connection links. will create a new hub used for handling creation and initialization of the links.
.B sxhub_init .B sxhub_init
will do the same, but it will take an already preallocated pointer. will do the same, but it will take an already preallocated pointer.
.br .br
.B sxhub_destroy .B sxhub_destroy
will deallocate all related to the connections set, include pointer will deallocate all related to the hub, include pointer
.BI ssys .BI ssys
, but , but
.B sxhub_free .B sxhub_free
@ -36,7 +36,7 @@ will not free this pointer consider it will be deallocated by user.
.SH RETURN VALUE .SH RETURN VALUE
Upon successful completion, the function Upon successful completion, the function
.B sxhub_create .B sxhub_create
will return a valid pointer to the connections set. will return a valid pointer to the newly created links hub.
.B sxhub_init .B sxhub_init
will return will return
.B 0 .B 0
@ -64,8 +64,8 @@ None.
.SH APPLICATION USAGE .SH APPLICATION USAGE
None. None.
.SH RATIONALE .SH RATIONALE
Connection link destroy function might be used carefully, the logic of there functions is a Link destroy function might be used carefully, the logic of there functions is a
send a special link layer message that will close the connection link on the master side. send a special link layer message that will close the link on the master side (and within masters hub).
The reason to care about is a delivery of all messages, channels and other stuff, because The reason to care about is a delivery of all messages, channels and other stuff, because
when this functions called all pending messages are drops. when this functions called all pending messages are drops.
.SH SEE ALSO .SH SEE ALSO