diff options
author | Michał Łyszczek <michal.lyszczek@bofc.pl> | 2021-05-21 02:08:37 +0200 |
---|---|---|
committer | Michał Łyszczek <michal.lyszczek@bofc.pl> | 2021-05-21 02:35:10 +0200 |
commit | b4b16d0134e544be9f8387cba1afbcb3ac19939e (patch) | |
tree | 9e1002b0371735c52d2715cadb8c1e173fc7d69f | |
parent | e6fbeea04948ee1a86c298d9227cbad1946ee9dd (diff) | |
download | psmq-b4b16d0134e544be9f8387cba1afbcb3ac19939e.tar.gz psmq-b4b16d0134e544be9f8387cba1afbcb3ac19939e.tar.bz2 psmq-b4b16d0134e544be9f8387cba1afbcb3ac19939e.zip |
man: update man pages
Signed-off-by: Michał Łyszczek <michal.lyszczek@bofc.pl>
-rw-r--r-- | man/psmq-pub.1 | 2 | ||||
-rw-r--r-- | man/psmq_building.7 | 4 | ||||
-rw-r--r-- | man/psmq_overview.7 | 5 | ||||
-rw-r--r-- | man/psmq_publish.3 | 15 |
4 files changed, 18 insertions, 8 deletions
diff --git a/man/psmq-pub.1 b/man/psmq-pub.1 index e486e19..7e977cf 100644 --- a/man/psmq-pub.1 +++ b/man/psmq-pub.1 @@ -91,7 +91,7 @@ cat file-with-content | Send sequence of binary data printf "\\x13\\x37\\x04\\x51" | .B psmq-pub --b/brok -t/topic1 +-b/brok -t/topic1 -B .SH "BUG REPORTING" .PP Please, report all bugs to "Michał Łyszczek <michal.lyszczek@bofc.pl>" diff --git a/man/psmq_building.7 b/man/psmq_building.7 index a278580..6ce0218 100644 --- a/man/psmq_building.7 +++ b/man/psmq_building.7 @@ -122,8 +122,8 @@ on such system, define this to 1. It is not possible to set this when building with autotools. C'mon, if you can use autotools you surely have signals. .SH DEPENDENCIES .PP -Broker needs -.B >=embedlog-v9999 +Broker and psmq-sub need +.B >=embedlog-v0.6.0 for logging. It can be downloaded from .B https://embedlog.bofc.pl diff --git a/man/psmq_overview.7 b/man/psmq_overview.7 index 3b76461..3d1271a 100644 --- a/man/psmq_overview.7 +++ b/man/psmq_overview.7 @@ -52,8 +52,8 @@ Some examples can be: .PP You can use any structure that best suits your needs. .PP -While both publishers and subscribers can use full form of topics, subsribers -can use +While both publishers and subscribers can use full form of topics, +only subsribers can use .B wildcards to subscribe to multiple topics with one subscription. There are 2 wildards. @@ -198,6 +198,7 @@ l l. \fBpsmq_timedreceive_ms\fR(3) as above but accepts [ms] instead of timespec \fBpsmq_subscribe\fR(3) subscribe to given topic to receive data \fBpsmq_unsubscribe\fR(3) unsubscribe from topic to not receive that data +\fBpsmq_ioctl\fR(3) alter how broker communicates with client .TE .SS PROGRAMS .PP diff --git a/man/psmq_publish.3 b/man/psmq_publish.3 index 4415243..9a86818 100644 --- a/man/psmq_publish.3 +++ b/man/psmq_publish.3 @@ -32,8 +32,11 @@ will be automatically set to 0. .PP If broker's control mqueue is full then this function will block until broker deals with some messages and make place in the queue. -Note that broker never blocks waiting for clients, so messages from mqueue are -processed immediately and without unnecessary delays. +Note that, by default, broker never blocks waiting for clients, so messages +from mqueue are processed immediately and without unnecessary delays. +Broker may block waiting for clients when you set high enough response timeout +value via +.BR psmq_ioctl_reply_timeout (3). .PP Successfull call means that message has been put into broker's queue with success it doesn't necessary mean that any client will receives that message. @@ -56,9 +59,15 @@ share single buffer of size This means topic size + payload size cannot exceed that value. Note, that topic will take strlen(topic) + 1 size on buffer, since topic is string so it will also transmit null terminator char. -This allows for some flexibility, as one message can contain large +This allows for some flexibility, as one message can contain large topic (as in PSMQ_MSG_MAX - 1 large) and no payload, and next publish can be opposite - short topic but large payload. +.PP +Only real data is sent over mqueue, if +.B PSMQ_MSG_MAX +is large like 256 bytes, but topic + payload is 10 bytes long, only +these 10 bytes will be actually copied over to the broker and clients, +not full buffer (256 bytes). .SH "RETURN VALUE" .PP 0 on success. -1 on errors with appropriate errno set. |