3party/libzmq
0
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-26 23:01:04 +08:00
Code Issues Projects Releases Wiki Activity
libzmq/doc/zmq_msg_set.adoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

39 lines
899 B
Plaintext
Raw Normal View History

Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
= zmq_msg_set(3)
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== NAME
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Simplified zmq_msg_get/set functions * Return integer property * Fixed up man pages, which were inaccurate * Fixed test case
2012-03-21 14:19:40 -05:00
zmq_msg_set - set message property
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== SYNOPSIS
Simplified zmq_msg_get/set functions * Return integer property * Fixed up man pages, which were inaccurate * Fixed test case
2012-03-21 14:19:40 -05:00
*int zmq_msg_set (zmq_msg_t '*message', int 'property', int 'value');*
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== DESCRIPTION
Simplified zmq_msg_get/set functions * Return integer property * Fixed up man pages, which were inaccurate * Fixed test case
2012-03-21 14:19:40 -05:00
The _zmq_msg_set()_ function shall set the property specified by the
'property' argument to the value of the 'value' argument for the 0MQ
message fragment pointed to by the 'message' argument.
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Simplified zmq_msg_get/set functions * Return integer property * Fixed up man pages, which were inaccurate * Fixed test case
2012-03-21 14:19:40 -05:00
Currently the _zmq_msg_set()_ function does not support any property names.
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== RETURN VALUE
Renamed peek/poke to get/set
2012-02-15 19:28:29 -06:00
The _zmq_msg_set()_ function shall return zero if successful. Otherwise it
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
shall return `-1` and set 'errno' to one of the values defined below.
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== ERRORS
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
*EINVAL*::
Simplified zmq_msg_get/set functions * Return integer property * Fixed up man pages, which were inaccurate * Fixed test case
2012-03-21 14:19:40 -05:00
The requested property _property_ is unknown.
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== SEE ALSO
Feature: improve docs (#4620) * Feature: improve see-also doc section
2023-11-03 11:36:47 +01:00
* xref:zmq_msg_get.adoc[zmq_msg_get]
* xref:zmq.adoc[zmq]
Renamed zmq_getmsgopt to zmq_msg_peek * Added zmq_msg_poke for orthogonality * Added zmq_msg_more for simplicity * Fixed up man pages and test program
2012-02-15 18:41:09 -06:00
Feature: modernize API documentation * migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-21 01:50:38 +02:00
== AUTHORS
Use of named authors on man pages is no longer a good idea since it puts off contributors and doesn't reflect the real process. I've taken out all named authors and referred to the contribution policy. Hopefully this will improve the contributions to the man pages.
2013-04-11 18:53:02 +02:00
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
Reference in New Issue Copy Permalink