| Sean Middleditch | 897e97f | 2009-11-02 11:16:47 -0800 | [diff] [blame] | 1 | .TH telnet_recv 3 LIBTELNET "" "TELNET Library" |
| 2 | |
| 3 | .SH NAME |
| 4 | \fBtelnet_recv\fP - process received protocol data |
| 5 | |
| 6 | .SH SYNOPSIS |
| 7 | .PP |
| 8 | \fB#include <libtelnet.h>\fP |
| 9 | .sp |
| 10 | .B "void telnet_recv( telnet_t *\fItelnet\fP, const char *\fIbuffer\fP, size_t \fIsize\fP );" |
| 11 | |
| 12 | .SH DESCRIPTION |
| 13 | .PP |
| 14 | The \fBtelnet_recv\fP function must be called by the host application whenever data is received on the underlying network socket associated with the TELNET connection. The received data is passed in, processed by the \fBlibtelnet\fP library, and events are generated corresponding to the parsed input. |
| 15 | |
| 16 | The parameter \fItelnet\fP is a state tracker instance created by a prior call to \fBtelnet_init\fP. |
| 17 | |
| 18 | The parameter \fIbuffer\fP is the byte buffer into which received data has been read, usually by a called to \fBrecv\fP. |
| 19 | |
| 20 | The parameter \fIsize\fP is the number of bytes in the \fIbuffer\fP parameter, which is the same as the positive return value of \fBrecv\fP. |
| 21 | |
| 22 | .SH SEE ALSO |
| 23 | .PP |
| 24 | \fBlibtelnet\fR(3), \fBtelnet_send\fR(3), \fBrecv\fR(3) |