libnet.txt

Libnet is a cross-platform library aimed at game developers. It has an abstract high level API, whic

you get on.

   Any other useful drivers would be much appreciated.  See
Chapter 7: Contacting the Authors.

4. Config files
***************

   The library will work without config files by using hardwired
defaults, but if you want to use other settings config files
are what you need.

   The system for config files was designed to allow other
non-Libnet data to be included in the same file.  It uses a
similar system to many other packages, like Windows' *.ini
files.

   * Config files are plain text files

   * They are split into several sections

   * Each section starts with a line containing only a title in
     square brackets (`[',`]') and ends with the next such title

   * Inside the sections there may be several settings of the
     form:  option = setting

   In fact what goes on inside the sections is entirely up to
the driver that owns the section; the above system is
recommended though.

   Libnet drivers won't mind at all if you put garbage at the
start or end of the file provided you don't duplicate any of
its section headings and the trailing garbage has a section
name separating it from the last Libnet driver.

   For full details of what sections each driver looks for and
which settings within those sections it recognises please see
the drivers' documentation.

   To load a config file you use the `net_loadconfig' function,
_before calling `net_init'_, passing it one of:

  a. a filename (with or without a path) to load

  b. a path with no filename

  c. `NULL'

   For [b] and [c] a default filename of `libnet.cfg' will be
used.  For [c] the file will be checked for in various
platform-dependent locations (e.g. the current directory, or
the directory containing the program, or the user's home
directory).

5. Notes on Libnet's structs
****************************

   `libnet.h' declares several structs -- `NET_CHANNEL',
`NET_CONN', `NET_DRIVER' and `NET_DRIVERNAME'. `NET_CHANNEL'
and `NET_CONN' are used by user programs and internally to hold
information about channels and conns; the user doesn't see
inside the struct.  `NET_DRIVER' is used internally to hold
information about network drivers.  `NET_DRIVERNAME' is used to
hold a driver's reference number and name; an array of these is
returned by the `net_getdrivernames' function.

   The definitions of these structs are in
`lib/include/internal.h'.  Beware that these definitions may
change from version to version; it's best not to use them in
user programs.  If you really need something and think the API
should publicise it, let me (gfoot) know and we can talk about
extending the API.

   The documentation about the structs has not yet been
converted to Texinfo format.

6. Future improvements to the library
*************************************

   Here are some possible enhancements for the future.  Other
suggestions for improvement are of course always welcome.  See
Chapter 7: Contacting the Authors.

   * Rather than querying all channels one by one, there could
     be a function to query them all at once, perhaps setting a
     flag in the `NET_CHANNEL' struct if data is waiting.  The
     user program could then issue one query call, and
     afterwards just check this flag.

7. Contacting the authors
*************************

   Authors' email addresses:

   * George Foot (gfoot):  [e-mail]

   * Chad Catlett (dwi):  [e-mail]

   * Ralph Deane

   * Peter Wang:  [e-mail]

   Before making queries about specific drivers, please look for
documentation on the driver in question, e.g. in this document
or in the `text' directory.  Also see the following chapter,
which discusses the netgame mailing list.

8. The netgame mailing list
***************************

   The netgame mailing list was created in Spring 1998.  You can
discuss any aspect of networked game programming.  Libnet
discussion is on topic, but the list is not just about Libnet.
The list does not generate a lot of traffic, but there are
people on the list with experience writing games using Libnet
and other libraries, including the authors of Libnet, so asking
this mailing list is better than asking the authors directly.

   To subscribe to the mailing list, please send an email to
[e-mail] with no subject, putting in the body of
the message:

     subscribe netgame name

replacing `name' with your name.  You'll be sent more
information about the mailing list when your subscription is
processed.

   The administrator of this mailing list is George Foot.

Variable/macro Index
********************

NET_DRIVER_IPX_DOS:
          See ``3.6 IPX from DOS''.
NET_DRIVER_LOCAL:
          See ``3.8 Local host''.
NET_DRIVER_NONET:
          See ``3.1 No networking''.
NET_DRIVER_SERIAL_DOS:
          See ``3.7 Serial link from DOS''.
NET_DRIVER_SOCKETS:
          See ``3.3 Berkeley sockets''.
NET_DRIVER_WSOCK_DOS:
          See ``3.5 Winsock from a DOS box''.
NET_DRIVER_WSOCK_WIN:
          See ``3.4 Winsock from Windows''.
Concept Index
*************

aims of Libnet:
          See ``1. Basic Aims''.
allocating a conn:
          See ``2.3.1 net_openconn''.
alphabetic list of functions:
          See ``2.5 Alphabetic List of Functions''.
assigning the target of a conn:
          See ``2.3.5 net_connect''.
authors:
          See ``7. Contacting the authors''.
basic aims of Libnet:
          See ``1. Basic Aims''.
Berkeley sockets (Unix Internet) driver:
          See ``3.3 Berkeley sockets''.
BSD sockets (Unix Internet) driver:
          See ``3.3 Berkeley sockets''.
channel:
          See ``2.2 Channel Functions''.
channel functions:
          See ``2.2 Channel Functions''.
checking for incoming packets on a conn:
          See ``2.3.12 net_query_rdm''.
checking whether a connecting conn has connected yet:
          See ``2.3.6 net_poll_connect''.
checking whether a listening conn has been contacted:
          See ``2.3.4 net_poll_listen''.
closing a conn:
          See ``2.3.2 net_closeconn''.
config files:
          See ``4. Config files''.
conn:
          See ``2.3 Connection Functions''.
conn functions:
          See ``2.3 Connection Functions''.
conn, checking for incoming packets:
          See ``2.3.12 net_query_rdm''.
conn, closing:
          See ``2.3.2 net_closeconn''.
conn, connecting:
          See ``2.3.5 net_connect''.
conn, connecting with callback:
          See ``2.3.8 net_connect_wait_cb''.
conn, connecting with callback and time limit:
          See ``2.3.9 net_connect_wait_cb_time''.
conn, connecting with time limit:
          See ``2.3.7 net_connect_wait_time''.
conn, dropping packets deliberately:
          See ``2.3.13 net_ignore_rdm''.
conn, functions to work with:
          See ``2.3 Connection Functions''.
conn, ignoring packets:
          See ``2.3.13 net_ignore_rdm''.
conn, listening:
          See ``2.3.3 net_listen''.
conn, opening:
          See ``2.3.1 net_openconn''.
conn, optimising network usage:
          See ``2.3.14 net_conn_stats''.
conn, packet queue status:
          See ``2.3.14 net_conn_stats''.
conn, peer's address:
          See ``2.3.15 net_getpeer''.
conn, polling (listening) for connection attempts:
          See ``2.3.4 net_poll_listen''.
conn, polling connection status:
          See ``2.3.6 net_poll_connect''.
conn, querying for incoming packets:
          See ``2.3.12 net_query_rdm''.
conn, receiving packets:
          See ``2.3.11 net_receive_rdm''.
conn, sending packets:
          See ``2.3.10 net_send_rdm''.
conn, starting to listen:
          See ``2.3.3 net_listen''.
conn, status of packet queues:
          See ``2.3.14 net_conn_stats''.
connecting a conn with callback:
          See ``2.3.8 net_connect_wait_cb''.
connecting a conn with callback and time limit:
          See ``2.3.9 net_connect_wait_cb_time''.
connecting a conn with time limit:
          See ``2.3.7 net_connect_wait_time''.
connecting conn, initiating:
          See ``2.3.5 net_connect''.
connecting conn, polling for status:
          See ``2.3.6 net_poll_connect''.
connection functions:
          See ``2.3 Connection Functions''.
contacting the authors:
          See ``7. Contacting the authors''.
contributors:
          See ``7. Contacting the authors''.
core functions:
          See ``2.1 Core Functions''.
creating a conn:
          See ``2.3.1 net_openconn''.
data, checking for on a conn:
          See ``2.3.12 net_query_rdm''.
data, querying for on a conn:
          See ``2.3.12 net_query_rdm''.
data, receiving on a conn:
          See ``2.3.11 net_receive_rdm''.
data, sending on a conn:
          See ``2.3.10 net_send_rdm''.
destroying a conn:
          See ``2.3.2 net_closeconn''.
DOS-based Internet:
          See ``3.9 Other drivers''.
DOS-based Internet (Winsock) driver:
          See ``3.5 Winsock from a DOS box''.
DOS-based IPX driver:
          See ``3.6 IPX from DOS''.
DOS-based serial driver:
          See ``3.7 Serial link from DOS''.
DOS-based Winsock driver:
          See ``3.5 Winsock from a DOS box''.
driver list functions:
          See ``2.4 Driver List Functions''.
drivers in Libnet:
          See ``3. Notes on Drivers in Libnet''.
dropping packets deliberately:
          See ``2.3.13 net_ignore_rdm''.
dummy (no networking) driver:
          See ``3.1 No networking''.
emailing the authors:
          See ``7. Contacting the authors''.
Ethernet (IPX) driver:
          See ``3.6 IPX from DOS''.
FreeBSD-based Internet (Berkeley sockets) driver:
          See ``3.3 Berkeley sockets''.
freeing a conn:
          See ``2.3.2 net_closeconn''.
functions:
          See ``2. Functions''.
functions, alphabetical list:
          See ``2.5 Alphabetic List of Functions''.
functions, channel:
          See ``2.2 Channel Functions''.
functions, conn:
          See ``2.3 Connection Functions''.
functions, core:
          See ``2.1 Core Functions''.
functions, driver list manipulation:
          See ``2.4 Driver List Functions''.
future developments:
          See ``6. Future improvements to the library''.
future drivers:
          See ``3.9 Other drivers''.
getting the address of a conn's peer:
          See ``2.3.15 net_getpeer''.
getting the status of a conn:
          See ``2.3.14 net_conn_stats''.
goals of Libnet:
          See ``1. Basic Aims''.
how to write a driver:
          See ``3.2 Template driver''.
ignoring a packet queued on a conn:
          See ``2.3.13 net_ignore_rdm''.
important messages:
          See ``2.3 Connection Functions''.
improvements:
          See ``6. Future improvements to the library''.
incoming packet count of a conn:
          See ``2.3.14 net_conn_stats''.
initiating a connection:
          See ``2.3.5 net_connect''.
internal loopback (local host) driver:
          See ``3.8 Local host''.
internals -- structs:
          See ``5. Notes on Libnet's structs''.
Internet from a DOS box:
          See ``3.5 Winsock from a DOS box''.
Internet from plain DOS:
          See ``3.9 Other drivers''.
Internet from Unix/Linux/FreeBSD:
          See ``3.3 Berkeley sockets''.
Internet from Windows:
          See ``3.4 Winsock from Windows''.
IP support in DOS boxes:
          See ``3.5 Winsock from a DOS box''.
IP support in Unix/Linux/FreeBSD:
          See ``3.3 Berkeley sockets''.
IP support in Windows:
          See ``3.4 Winsock from Windows''.
IPX driver:
          See ``3.6 IPX from DOS''.
Kali and Libnet:
          See ``3.9 Other drivers''.
LAN (IPX) driver:
          See ``3.6 IPX from DOS''.
large packets, ignoring:
          See ``2.3.13 net_ignore_rdm''.
Linux-based Internet (Berkeley sockets) driver:
          See ``3.3 Berkeley sockets''.
list of drivers:
          See ``3. Notes on Drivers in Libnet''.
list of functions:
          See ``2.5 Alphabetic List of Functions''.
listening conn, initiating:
          See ``2.3.3 net_listen''.
listening conn, polling for status:
          See ``2.3.4 net_poll_listen''.
local host driver:
          See ``3.8 Local host''.
loopback (local host) driver:
          See ``3.8 Local host''.
low level packet sending:
          See ``2.2 Channel Functions''.
mailing list:
          See ``8. The netgame mailing list''.
manipulating driver lists:
          See ``2.4 Driver List Functions''.
modem driver:
          See ``3.7 Serial link from DOS''.
NET_CHANNEL struct:
          See ``5. Notes on Libnet's structs''.
NET_CONN struct:
          See ``5. Notes on Libnet's structs''.
NET_DRIVER struct:
          See ``5. Notes on Libnet's structs''.
NET_DRIVERNAME struct:
          See ``5. Notes on Libnet's structs''.
netgame mailing list:
          See ``8. The netgame mailing list''.
no networking (dummy) driver:
          See ``3.1 No networking''.
nonet driver:
          See ``3.1 No networking''.
null modem driver:
          See ``3.7 Serial link from DOS''.
opening a conn:
          See ``2.3.1 net_openconn''.
optimising network usage:
          See ``2.3.14 net_conn_stats''.
other drivers:
          See ``3.9 Other drivers''.
outgoing packet count of a conn:
          See ``2.3.14 net_conn_stats''.
packet queue status of a conn:
          See ``2.3.14 net_conn_stats''.
packets, checking for on a conn:
          See ``2.3.12 net_query_rdm''.
packets, dropping deliberately:
          See ``2.3.13 net_ignore_rdm''.
packets, querying for on a conn:
          See ``2.3.12 net_query_rdm''.
packets, receiving on a conn:
          See ``2.3.11 net_receive_rdm''.
packets, sending on a conn:
          See ``2.3.10 net_send_rdm''.
peer, definition:
          See ``2.3.15 net_getpeer''.
peer, getting address of:
          See ``2.3.15 net_getpeer''.
plans for the future:
          See ``6. Future improvements to the library''.
polling a conn for connection status:
          See ``2.3.6 net_poll_connect''.
polling a listening conn for connection status:
          See ``2.3.4 net_poll_listen''.
PPP driver:
          See ``3.9 Other drivers''.
querying for incoming packets on a conn:
          See ``2.3.12 net_query_rdm''.
queue status of a conn:
          See ``2.3.14 net_conn_stats''.
RDM:
          See ``2.3 Connection Functions''.
RDM, checking for:
          See ``2.3.12 net_query_rdm''.
RDM, ignoring:
          See ``2.3.13 net_ignore_rdm''.
RDM, querying for:
          See ``2.3.12 net_query_rdm''.
RDM, receiving:
          See ``2.3.11 net_receive_rdm''.
RDM, sending:
          See ``2.3.10 net_send_rdm''.
reading from a conn:
          See ``2.3.11 net_receive_rdm''.
receiving packets on a conn:
          See ``2.3.11 net_receive_rdm''.
receiving RDMs:
          See ``2.3.11 net_receive_rdm''.
reliable communication, functions:
          See ``2.3 Connection Functions''.
sending packets on a conn:
          See ``2.3.10 net_send_rdm''.
sending RDMs:
          See ``2.3.10 net_send_rdm''.
serial driver:
          See ``3.7 Serial link from DOS''.
setting the target of a conn:
          See ``2.3.5 net_connect''.
settings in config files:
          See ``4. Config files''.
starting a connection attempt:
          See ``2.3.5 net_connect''.
starting to listen for connections on a conn:
          See ``2.3.3 net_listen''.
structs:
          See ``5. Notes on Libnet's structs''.
subscribing to the netgame mailing list:
          See ``8. The netgame mailing list''.
TCP/IP support in DOS boxes:
          See ``3.5 Winsock from a DOS box''.
TCP/IP support in Unix/Linux/FreeBSD:
          See ``3.3 Berkeley sockets''.
TCP/IP support in Windows:
          See ``3.4 Winsock from Windows''.
template driver:
          See ``3.2 Template driver''.
UDP/IP support in DOS boxes:
          See ``3.5 Winsock from a DOS box''.
UDP/IP support in Unix/Linux/FreeBSD:
          See ``3.3 Berkeley sockets''.
UDP/IP support in Windows:
          See ``3.4 Winsock from Windows''.
Unix-based Internet (Berkeley sockets) driver:
          See ``3.3 Berkeley sockets''.
unreliable communication, functions:
          See ``2.2 Channel Functions''.
Windows-based Internet (Winsock) driver:
          See ``3.4 Winsock from Windows''.
Windows-based Winsock driver:
          See ``3.4 Winsock from Windows''.
Winsock 2 in DOS (lack of support):
          See ``3.5 Winsock from a DOS box''.
Winsock driver for DOS:
          See ``3.5 Winsock from a DOS box''.
Winsock driver for Windows:
          See ``3.4 Winsock from Windows''.
writing your own drivers:
          See ``3.2 Template driver''.
Table of Contents
*****************


Libnet documentation

1. Basic Aims

2. Functions
  2.1 Core Functions
    2.1.1 net_init
    2.1.2 net_register_driver
    2.1.3 net_loadconfig
    2.1.4 net_getdrivernames
    2.1.5 net_detectdrivers
    2.1.6 net_initdrivers
    2.1.7 net_shutdown
  2.2 Channel Functions
    2.2.1 net_openchannel
    2.2.2 net_closechannel
    2.2.3 net_assigntarget
    2.2.4 net_getlocaladdress
    2.2.5 net_send
    2.2.6 net_receive
    2.2.7 net_query
  2.3 Connection Functions
    2.3.1 net_openconn
    2.3.2 net_closeconn
    2.3.3 net_listen
    2.3.4 net_poll_listen
    2.3.5 net_connect
    2.3.6 net_poll_connect
    2.3.7 net_connect_wait_time
    2.3.8 net_connect_wait_cb
    2.3.9 net_connect_wait_cb_time
    2.3.10 net_send_rdm
    2.3.11 net_receive_rdm
    2.3.12 net_query_rdm
    2.3.13 net_ignore_rdm
    2.3.14 net_conn_stats
    2.3.15 net_getpeer
  2.4 Driver List Functions
    2.4.1 net_driverlist_create
    2.4.2 net_driverlist_destroy
    2.4.3 net_driverlist_clear
    2.4.4 net_driverlist_add
    2.4.5 net_driverlist_remove
    2.4.6 net_driverlist_add_list
    2.4.7 net_driverlist_remove_list
    2.4.8 net_driverlist_test
    2.4.9 net_driverlist_foreach
    2.4.10 net_driverlist_count
  2.5 Alphabetic List of Functions

3. Notes on Drivers in Libnet
  3.1 No networking
  3.2 Template driver
  3.3 Berkeley sockets
  3.4 Winsock from Windows
  3.5 Winsock from a DOS box
  3.6 IPX from DOS
  3.7 Serial link from DOS
  3.8 Local host
  3.9 Other drivers

4. Config files

5. Notes on Libnet's structs

6. Future improvements to the library

7. Contacting the authors

8. The netgame mailing list

Variable/macro Index

Concept Index