osmocom
/
libtelnet
mirror of https://gerrit.osmocom.org/libtelnet
11
0
Fork 0
Code Releases Activity

documentation update

This commit is contained in:
Sean Middleditch 2009-09-19 14:39:58 -07:00
parent d2466a01b6
commit be230ee82a
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
NEWS
View File

@ -1,3 +1,10 @@
Version 0.12
============
* added pkg-config file
* telnet_t is now a private data structure
* telnet_init() allocates memory and returns a pointer
Version 0.11
============

22
README
View File

@ -91,13 +91,13 @@ IIa. Initialization
all connections if you support a fixed set of options. Most
applications will support only a fixed set of options.
void telnet_init(telnet_t *telnet, const telnet_telopts_t *telopts,
telnet_t *telnet_init(const telnet_telopts_t *telopts,
telnet_event_handler_t handler, unsigned char flags,
void *user_data);
The telnet_init() function is responsible for initializing the
data in a telnet_t structure. It must be called immediately after
establishing a connection and before any other libtelnet API calls
are made.
The telnet_init() function is responsible for allocating memory
and initializing the data in a telnet_t structure. It must be
called immediately after establishing a connection and before any
other libtelnet API calls are made.
The telopts field is the telopt support table as described above.
@ -116,11 +116,15 @@ IIa. Initialization
TELNET_FLAG_PROXY
Operate in proxy mode. This disables the RFC1143 support and
enables automatic detection of COMPRESS2 streams.
If telnet_init() fails to allocate the required memory, the
returned pointer will be zero.
boid telnet_free(telnet_t *telnet);
Releases any internal memory allocated by libtelnet. This must be
called whenever a connection is closed, or you will incur memory
leaks.
void telnet_free(telnet_t *telnet);
Releases any internal memory allocated by libtelnet for the given
telnet pointer. This must be called whenever a connection is
closed, or you will incur memory leaks. The pointer passed in may
no longer be used afterwards.
IIb. Receiving Data