aboutsummaryrefslogtreecommitdiff
path: root/src/shared/lua_api/load_net.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/shared/lua_api/load_net.cpp')
-rw-r--r--src/shared/lua_api/load_net.cpp28
1 files changed, 14 insertions, 14 deletions
diff --git a/src/shared/lua_api/load_net.cpp b/src/shared/lua_api/load_net.cpp
index b377cc5..bff55cf 100644
--- a/src/shared/lua_api/load_net.cpp
+++ b/src/shared/lua_api/load_net.cpp
@@ -1,11 +1,11 @@
-/***
+/*
+TODO:Fix documentation or find a better home for this example code.
The net library
Exposes various structs, constants, and functions for passing messages
A list of protocols that can be used when creating sockets.
The number values below are only for refrence. You should use net.PAIR, net.BUS,
ect.
-@module net
@usage
--Server
local s = net.newsocket(net.REP)
@@ -67,7 +67,7 @@ extern "C" {
/***
1 to 1 protocol.
-@field PAIR 1
+@field net.PAIR
*/
#define PAIR 1
@@ -75,63 +75,63 @@ extern "C" {
Many to many protocol.
When this socket sends messages, it does not receive a copy of the message
it just sent.
-@field BUS 2
+@field net.BUS
*/
#define BUS 2
/***
Publish protocol.
The first half of the pub/sub protocol.
-@field PUB 3
+@field net.PUB
*/
#define PUB 3
/***
Subscribe protocol
The second half of the pub/sub protocol.
-@field SUB 4
+@field net.SUB
*/
#define SUB 4
/***
Pull protocol.
The first half of the push/pull protocol.
-@field PULL 5
+@field net.PULL
*/
#define PULL 5
/***
Push protocol.
The second half of the push/pull protocol.
-@field PUSH 6
+@field net.PUSH
*/
#define PUSH 6
/***
Request protocol.
The first half of the request/reply protocol.
-@field REQ 7
+@field net.REQ
*/
#define REQ 7
/***
Reply protocol.
The second half of the request/reply protocol.
-@field REP 8
+@field net.REP
*/
#define REP 8
/***
Respond protocol.
The second half of the survey/respond protocol.
-@field RESPOND 9
+@field net.RESPOND
*/
#define RESPOND 9
/***
Survey protocol.
The first half of the survey/respond protocol.
-@field SURVEY 10
+@field net.SURVEY
*/
#define SURVEY 10
@@ -597,8 +597,8 @@ int netclose(lua_State* L){//{socket}
}
/***
-@field fd
-@table net.socket
+The opaque socket descriptor for this socket.
+@field socket.fd The descriptor
@domain shared
*/