fixes manpages;
This commit is contained in:
parent
78d6226a43
commit
67f409dd99
@ -16,7 +16,7 @@ int sxchannel_close(sxchnl_t *channel);
|
||||
.B sxchannel_open
|
||||
will open RPC channel using
|
||||
.B co
|
||||
connection link with specified type via
|
||||
hub link with specified type determined by
|
||||
.B type
|
||||
that available/permitted to use for current peer.
|
||||
.br
|
||||
|
@ -1,12 +1,12 @@
|
||||
.TH SXHUB_CREATE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
|
||||
.SH NAME
|
||||
sxhub_create \- Allocate and initialize connections system
|
||||
sxhub_create \- Allocate and initialize links hub
|
||||
.br
|
||||
sxhub_init \- Initialize connections system
|
||||
sxhub_init \- Initialize links hub
|
||||
.br
|
||||
sxhub_destroy \- Destroy connections system
|
||||
sxhub_destroy \- Destroy links hub
|
||||
.br
|
||||
sxhub_free \- Free all stuff allocated for connections system
|
||||
sxhub_free \- Free all stuff allocated for hub
|
||||
.SH SYNOPSIS
|
||||
.B #include <sxmp/sxmp.h>
|
||||
.sp
|
||||
@ -22,12 +22,12 @@ int sxhub_free(sxhub_t *ssys);
|
||||
.sp
|
||||
.SH DESCRIPTION
|
||||
.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
|
||||
will do the same, but it will take an already preallocated pointer.
|
||||
.br
|
||||
.B sxhub_destroy
|
||||
will deallocate all related to the connections set, include pointer
|
||||
will deallocate all related to the hub, include pointer
|
||||
.BI ssys
|
||||
, but
|
||||
.B sxhub_free
|
||||
@ -36,7 +36,7 @@ will not free this pointer consider it will be deallocated by user.
|
||||
.SH RETURN VALUE
|
||||
Upon successful completion, the function
|
||||
.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
|
||||
will return
|
||||
.B 0
|
||||
@ -64,8 +64,8 @@ None.
|
||||
.SH APPLICATION USAGE
|
||||
None.
|
||||
.SH RATIONALE
|
||||
Connection 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.
|
||||
Link destroy function might be used carefully, the logic of there functions is a
|
||||
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
|
||||
when this functions called all pending messages are drops.
|
||||
.SH SEE ALSO
|
||||
|
Loading…
x
Reference in New Issue
Block a user