diff options
| author | Philip Withnall <philip.withnall@collabora.co.uk> | 2010-01-20 22:51:45 -0500 |
|---|---|---|
| committer | Olivier Crête <olivier.crete@collabora.com> | 2014-01-31 01:48:59 -0500 |
| commit | 949f979a98498d8ceab2a70696f1dbdc9ab96b7f (patch) | |
| tree | 8fce1b6ce9cff42c84268dd4dd47fca21ba3d97e /docs | |
| parent | 3724af1a0258ba9e9a455cfb3eec65e41ab907fd (diff) | |
| download | libnice-949f979a98498d8ceab2a70696f1dbdc9ab96b7f.tar.gz | |
agent: Add support for GIO-style I/O streams
This adds three new classes:
• NiceIOStream
• NiceInputStream
• NiceOutputStream
which allow wrapping a single stream/component pair in an I/O stream
which can be used with the standard GIO functions.
The streams are constructed as wrappers around a NiceAgent, with changes
to the NiceAgent’s properties affecting all instantiated streams.
Streams are only supported for reliable connections.
If the NiceAgent stream which underlies a NiceInputStream,
NiceOutputStream or NiceIOStream is removed, the I/O stream is marked as
closed.
This is based on work originally done by Youness Alaoui
<youness.alaoui@collabora.co.uk>.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/libnice/Makefile.am | 8 | ||||
| -rw-r--r-- | docs/reference/libnice/libnice-docs.sgml | 5 | ||||
| -rw-r--r-- | docs/reference/libnice/libnice-sections.txt | 54 |
3 files changed, 64 insertions, 3 deletions
diff --git a/docs/reference/libnice/Makefile.am b/docs/reference/libnice/Makefile.am index 952b2ec..6d01065 100644 --- a/docs/reference/libnice/Makefile.am +++ b/docs/reference/libnice/Makefile.am @@ -47,8 +47,12 @@ HFILE_GLOB=$(DOC_SOURCE_DIR)/agent/agent.h $(DOC_SOURCE_DIR)/agent/address.h \ $(DOC_SOURCE_DIR)/stun/usages/ice.h \ $(DOC_SOURCE_DIR)/stun/usages/timer.h \ $(DOC_SOURCE_DIR)/stun/usages/turn.h \ - $(DOC_SOURCE_DIR)/agent/pseudotcp.h \ -CFILE_GLOB=$(DOC_SOURCE_DIR)/agent/agent.c $(DOC_SOURCE_DIR)/agent/pseudotcp.c + $(DOC_SOURCE_DIR)/agent/pseudotcp.h \ + $(DOC_SOURCE_DIR)/agent/iostream.h + +CFILE_GLOB=$(DOC_SOURCE_DIR)/agent/agent.c \ + $(DOC_SOURCE_DIR)/agent/pseudotcp.c \ + $(DOC_SOURCE_DIR)/agent/iostream.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h diff --git a/docs/reference/libnice/libnice-docs.sgml b/docs/reference/libnice/libnice-docs.sgml index f073d39..4e76764 100644 --- a/docs/reference/libnice/libnice-docs.sgml +++ b/docs/reference/libnice/libnice-docs.sgml @@ -19,7 +19,10 @@ <xi:include href="xml/candidate.xml"/> </chapter> <chapter> - <title>Libnice helper functions </title> + <title>Libnice helper objects and functions </title> + <xi:include href="xml/nice_io_stream.xml"/> + <xi:include href="xml/nice_input_stream.xml"/> + <xi:include href="xml/nice_output_stream.xml"/> <xi:include href="xml/debug.xml"/> <xi:include href="xml/interfaces.xml"/> </chapter> diff --git a/docs/reference/libnice/libnice-sections.txt b/docs/reference/libnice/libnice-sections.txt index bad2dfb..57fed70 100644 --- a/docs/reference/libnice/libnice-sections.txt +++ b/docs/reference/libnice/libnice-sections.txt @@ -260,3 +260,57 @@ pseudo_tcp_set_debug_level pseudo_tcp_socket_get_available_bytes pseudo_tcp_socket_can_send </SECTION> + +<SECTION> +<FILE>nice_io_stream</FILE> +<TITLE>NiceIOStream</TITLE> +NiceIOStream +nice_io_stream_new +<SUBSECTION Standard> +NICE_IO_STREAM +NICE_IO_STREAM_CLASS +NICE_IO_STREAM_GET_CLASS +NICE_IS_IO_STREAM +NICE_IS_IO_STREAM_CLASS +NICE_TYPE_IO_STREAM +nice_io_stream_get_type +<SUBSECTION Private> +NiceIOStreamClass +NiceIOStreamPrivate +</SECTION> + +<SECTION> +<FILE>nice_input_stream</FILE> +<TITLE>NiceInputStream</TITLE> +NiceInputStream +nice_input_stream_new +<SUBSECTION Standard> +NICE_INPUT_STREAM +NICE_INPUT_STREAM_CLASS +NICE_INPUT_STREAM_GET_CLASS +NICE_IS_INPUT_STREAM +NICE_IS_INPUT_STREAM_CLASS +NICE_TYPE_INPUT_STREAM +nice_input_stream_get_type +<SUBSECTION Private> +NiceInputStreamClass +NiceInputStreamPrivate +</SECTION> + +<SECTION> +<FILE>nice_output_stream</FILE> +<TITLE>NiceOutputStream</TITLE> +NiceOutputStream +nice_output_stream_new +<SUBSECTION Standard> +NICE_OUTPUT_STREAM +NICE_OUTPUT_STREAM_CLASS +NICE_OUTPUT_STREAM_GET_CLASS +NICE_IS_OUTPUT_STREAM +NICE_IS_OUTPUT_STREAM_CLASS +NICE_TYPE_OUTPUT_STREAM +nice_output_stream_get_type +<SUBSECTION Private> +NiceOutputStreamClass +NiceOutputStreamPrivate +</SECTION> |