gnet-iochannel.html

GNet是一个简单的网络库。它是目标定向的

><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2943"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>len</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2948"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>bytes_read</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2953"><SPAN
STYLE="white-space: nowrap"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
>&#13;</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN2958"
></A
><H3
><A
NAME="GNET-IO-CHANNEL-READLINE-STRDUP"
></A
>gnet_io_channel_readline_strdup ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GIOERROR"
>GIOError</GTKDOCLINK
>    gnet_io_channel_readline_strdup (<GTKDOCLINK
HREF="GIOCHANNEL"
>GIOChannel</GTKDOCLINK
> *channel,
                                             <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> **buf_ptr,
                                             <GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *bytes_read);</PRE
></TD
></TR
></TABLE
><P
>Read a line from the channel.  The line will be null-terminated and
include the newline character.  Similarly to g_strdup_printf, a
buffer large enough to hold the string will be allocated.</P
><P
>Warnings: (in the gotcha sense, not the bug sense)</P
><P
>1. If the last character of the buffer is not a newline, the line
was truncated by EOF.  So, do not assume the buffer ends with a
newline.</P
><P
>2. <TT
CLASS="PARAMETER"
><I
>bytes_read</I
></TT
> is actually the number of bytes put in the buffer.
That is, it includes the terminating null character.</P
><P
>3. Null characters can appear in the line before the terminating
null (I could send the string "Hello world\0\n").  If this matters
in your program, check the string length of the buffer against the
bytes read.</P
><P
></P
><P
></P
><TABLE
CLASS="VARIABLELIST"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
WIDTH="100%"
BGCOLOR="#FFD0D0"
><TBODY
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2974"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>channel</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2979"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>buf_ptr</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2984"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>bytes_read</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN2989"><SPAN
STYLE="white-space: nowrap"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
>&#13;</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN2994"
></A
><H3
><A
NAME="GNETIOCHANNELWRITEASYNCSTATUS"
></A
>enum GNetIOChannelWriteAsyncStatus</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum {
  GNET_IOCHANNEL_WRITE_ASYNC_STATUS_OK,
  GNET_IOCHANNEL_WRITE_ASYNC_STATUS_TIMEOUT,
  GNET_IOCHANNEL_WRITE_ASYNC_STATUS_ERROR
} GNetIOChannelWriteAsyncStatus;</PRE
></TD
></TR
></TABLE
><P
>Status for an asynchronous write via
  <A
HREF="gnet-iochannel.html#GNET-IO-CHANNEL-WRITE-ASYNC"
>gnet_io_channel_write_async</A
>(), passed by
  GNetIOChannelWriteAsyncFunc.</P
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN3001"
></A
><H3
><A
NAME="GNETIOCHANNELWRITEASYNCID"
></A
>GNetIOChannelWriteAsyncID</H3
><P
>ID of an asynchronous write started with
  <A
HREF="gnet-iochannel.html#GNET-IO-CHANNEL-WRITE-ASYNC"
>gnet_io_channel_write_async</A
>().  The connection can be canceled by
  calling <A
HREF="gnet-iochannel.html#GNET-IO-CHANNEL-WRITE-ASYNC-CANCEL"
>gnet_io_channel_write_async_cancel</A
>() with the ID.</P
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN3008"
></A
><H3
><A
NAME="GNET-IO-CHANNEL-WRITE-ASYNC"
></A
>gnet_io_channel_write_async ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnet-iochannel.html#GNETIOCHANNELWRITEASYNCID"
>GNetIOChannelWriteAsyncID</A
> gnet_io_channel_write_async
                                            (<GTKDOCLINK
HREF="GIOCHANNEL"
>GIOChannel</GTKDOCLINK
> *iochannel,
                                             <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *buffer,
                                             <GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> length,
                                             <GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> timeout,
                                             <GTKDOCLINK
HREF="GNETIOCHANNELWRITEASYNCFUNC"
>GNetIOChannelWriteAsyncFunc</GTKDOCLINK
> func,
                                             <GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> user_data);</PRE
></TD
></TR
></TABLE
><P
>Write <TT
CLASS="PARAMETER"
><I
>buffer</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>iochannel</I
></TT
> asynchronously.  When the operation is
 complete, <TT
CLASS="PARAMETER"
><I
>func</I
></TT
> is called.  The callback may also be called if
 there is an error or timeout.  The timeout is in milliseconds.
 Use a <TT
CLASS="PARAMETER"
><I
>timeout</I
></TT
> of 0 if no timeout is needed.</P
><P
></P
><P
></P
><TABLE
CLASS="VARIABLELIST"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
WIDTH="100%"
BGCOLOR="#FFD0D0"
><TBODY
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3026"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>iochannel</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3031"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>buffer</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3036"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>length</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3041"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>timeout</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3046"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>func</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3051"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>user_data</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3056"><SPAN
STYLE="white-space: nowrap"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
>&#13;</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN3061"
></A
><H3
><A
NAME="GNET-IO-CHANNEL-WRITE-ASYNC-CANCEL"
></A
>gnet_io_channel_write_async_cancel ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gnet_io_channel_write_async_cancel
                                            (<A
HREF="gnet-iochannel.html#GNETIOCHANNELWRITEASYNCID"
>GNetIOChannelWriteAsyncID</A
> id,
                                             <GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> delete_buffer);</PRE
></TD
></TR
></TABLE
><P
>Cancel an asynchronous write that was started with
 <A
HREF="gnet-iochannel.html#GNET-IO-CHANNEL-WRITE-ASYNC"
>gnet_io_channel_write_async</A
>().  Set <TT
CLASS="PARAMETER"
><I
>delete_buffer</I
></TT
> to TRUE if the
 buffer should be deleted.  TODO: The delete_buffer functionality
 will probably be removed in the next version (it will remain in
 GConn).</P
><P
></P
><P
></P
><TABLE
CLASS="VARIABLELIST"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
WIDTH="100%"
BGCOLOR="#FFD0D0"
><TBODY
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3072"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>id</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3077"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>delete_buffer</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
>&#13;</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN3082"
></A
><H3
><A
NAME="GNETIOCHANNELREADASYNCSTATUS"
></A
>enum GNetIOChannelReadAsyncStatus</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum {
  GNET_IOCHANNEL_READ_ASYNC_STATUS_OK,
  GNET_IOCHANNEL_READ_ASYNC_STATUS_TIMEOUT,
  GNET_IOCHANNEL_READ_ASYNC_STATUS_ERROR
} GNetIOChannelReadAsyncStatus;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN3087"
></A
><H3
><A
NAME="GNETIOCHANNELREADASYNCID"
></A
>GNetIOChannelReadAsyncID</H3
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN3091"
></A
><H3
><A
NAME="GNET-IO-CHANNEL-READ-ASYNC"
></A
>gnet_io_channel_read_async ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnet-iochannel.html#GNETIOCHANNELREADASYNCID"
>GNetIOChannelReadAsyncID</A
> gnet_io_channel_read_async
                                            (<GTKDOCLINK
HREF="GIOCHANNEL"
>GIOChannel</GTKDOCLINK
> *iochannel,
                                             <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *buffer,
                                             <GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> length,
                                             <GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> timeout,
                                             <GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> read_one_byte_at_a_time,
                                             <GTKDOCLINK
HREF="GNETIOCHANNELREADASYNCCHECKFUNC"
>GNetIOChannelReadAsyncCheckFunc</GTKDOCLINK
> check_func,
                                             <GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> check_user_data,
                                             <GTKDOCLINK
HREF="GNETIOCHANNELREADASYNCFUNC"
>GNetIOChannelReadAsyncFunc</GTKDOCLINK
> func,
                                             <GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> user_data);</PRE
></TD
></TR
></TABLE
><P
></P
><P
></P
><TABLE
CLASS="VARIABLELIST"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
WIDTH="100%"
BGCOLOR="#FFD0D0"
><TBODY
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3107"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>iochannel</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3112"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>buffer</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3117"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>length</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3122"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>timeout</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3127"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>read_one_byte_at_a_time</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR
><TR
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="20%"
><A
NAME="AEN3132"><SPAN
STYLE="white-space: nowrap"
><TT
CLASS="PARAMETER"
><I
>check_func</I
></TT
>&nbsp;:</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="80%"
><P
></P
></TD
></TR