From 8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Wed, 31 Oct 2018 12:47:37 -0400 Subject: Removed generated documentation Removed documentation, users should generate it on-the-fly if needed. This is to keep the codebase in a consistent state. If the code is changed, the documentation must be chagned too, otherwise it is possible to see the codebase with old documentation. Additionally, updaing documentation with changes to the codebase would clutter diffs. --- doc/index.html | 423 --------------------------------------------------------- 1 file changed, 423 deletions(-) delete mode 100644 doc/index.html (limited to 'doc/index.html') diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index 517b2c9..0000000 --- a/doc/index.html +++ /dev/null @@ -1,423 +0,0 @@ - - - - - Reference - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module net

-

The net library -Exposes various structs, constants, and functions for passing messages

-

- - -

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
stream:readint ()Read an integer from the stream
stream:readdouble ()Read double percision float from the stream
stream:readdata (size)Read some data from the stream
stream:readstring ()Read a string from the stream
stream:writeint (i)Write an integer to the stream
stream:writedouble (d)Write a double percision float to the stream
stream:writedata (d)Write some data to the stream
stream:writestring (s)Write a string to the stream
socket:bind (where)
receive (message, callback)
newsocket ()
-

Tables

- - - - - -
socket
- -
-
- - -

Functions

- -
-
- - stream:readint () -
-
- Read an integer from the stream - - - - -

Returns:

-
    - - number - The number read from the stream -
- - - - -
-
- - stream:readdouble () -
-
- Read double percision float from the stream - - - - -

Returns:

-
    - - number - The number read from the stream -
- - - - -
-
- - stream:readdata (size) -
-
- Read some data from the stream - - - -

Parameters:

-
    -
  • size - number - The size of the data to read from the stream -
    • -
- -

Returns:

-
    - - string - The data read from the stream -
- - - - -
-
- - stream:readstring () -
-
- Read a string from the stream - - - - -

Returns:

-
    - - string - The string read from the stream -
- - - - -
-
- - stream:writeint (i) -
-
- Write an integer to the stream - - - -

Parameters:

-
    -
  • i - number - The integer to write to the stream -
    • -
- - - - - -
-
- - stream:writedouble (d) -
-
- Write a double percision float to the stream - - - -

Parameters:

-
    -
  • d - number - The number to write to the stream -
    • -
- - - - - -
-
- - stream:writedata (d) -
-
- Write some data to the stream - - - -

Parameters:

-
    -
  • d - number - The number to write to the stream -
    • -
- -

Returns:

-
    - - number - The number of bytes written to the stream -
- - - - -
-
- - stream:writestring (s) -
-
- Write a string to the stream - - - -

Parameters:

-
    -
  • s - string - The string to the stream -
    • -
- - - - - -
-
- - socket:bind (where) -
-
- - - - -

Parameters:

-
    -
  • where - string - Where to connect this socket to -
    • -
- - - - -

Usage:

-
    - 
    local s = net.newsocket()
-s:bind("127.0.0.1")
-s:receive("ping",function(stream)
-	print(instream:readstring())
-end)
-local c = net.newsocket()
-c:connect("127.0.0.1")
    -
- -
-
- - receive (message, callback) -
-
- - - - -

Parameters:

-
    -
  • message - string - The message to bind this function to -
    • -
  • callback - function - The function to call when this message is received -
    • -
- - - - - -
-
- - newsocket () -
-
- - -

domain:

-
    - shared -
- - -

Returns:

-
    - - net.socket -
- - - - -
-
-

Tables

- -
-
- - socket -
-
- - -

domain:

-
    - shared -
- -

Fields:

-
    -
  • fd - -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6 -Last updated 2018-07-03 16:38:22 -
-
- - -- cgit v1.2.3-70-g09d2