From 04347084d658baedd6dc615fa34b62d3c19f1d2e Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Wed, 28 Jan 2015 15:15:54 +0100
Subject: NetworkTest plugin: Added cNetwork:Connect test code.
---
MCServer/Plugins/NetworkTest/Info.lua | 46 ++++++++++++++++++++
MCServer/Plugins/NetworkTest/NetworkTest.lua | 63 ++++++++++++++++++++++++++++
2 files changed, 109 insertions(+)
create mode 100644 MCServer/Plugins/NetworkTest/Info.lua
create mode 100644 MCServer/Plugins/NetworkTest/NetworkTest.lua
(limited to 'MCServer')
diff --git a/MCServer/Plugins/NetworkTest/Info.lua b/MCServer/Plugins/NetworkTest/Info.lua
new file mode 100644
index 000000000..6bb639860
--- /dev/null
+++ b/MCServer/Plugins/NetworkTest/Info.lua
@@ -0,0 +1,46 @@
+
+-- Info.lua
+
+-- Implements the g_PluginInfo standard plugin description
+
+g_PluginInfo =
+{
+ Name = "NetworkTest",
+ Version = "1",
+ Date = "2015-01-28",
+ Description = [[Implements test code (and examples) for the cNetwork API]],
+
+ Commands =
+ {
+ },
+
+ ConsoleCommands =
+ {
+ net =
+ {
+ Subcommands =
+ {
+ client =
+ {
+ HelpString = "Connects, as a client, to a specified webpage (google.com by default) and downloads its front page using HTTP",
+ Handler = HandleConsoleNetClient,
+ ParameterCombinations =
+ {
+ {
+ Params = "",
+ Help = "Connects, as a client, to google.com and downloads its front page using HTTP",
+ },
+ {
+ Params = "host [port]",
+ Help = "Connects, as a client, to the specified host and downloads its front page using HTTP",
+ },
+ }, -- ParameterCombinations
+ }, -- client
+ }, -- Subcommands
+ }, -- net
+ },
+}
+
+
+
+
diff --git a/MCServer/Plugins/NetworkTest/NetworkTest.lua b/MCServer/Plugins/NetworkTest/NetworkTest.lua
new file mode 100644
index 000000000..1a24d4865
--- /dev/null
+++ b/MCServer/Plugins/NetworkTest/NetworkTest.lua
@@ -0,0 +1,63 @@
+
+-- NetworkTest.lua
+
+-- Implements a few tests for the cNetwork API
+
+
+
+
+
+function Initialize()
+ -- Use the InfoReg shared library to process the Info.lua file:
+ dofile(cPluginManager:GetPluginsPath() .. "/InfoReg.lua")
+ RegisterPluginInfoCommands()
+ RegisterPluginInfoConsoleCommands()
+
+ return true
+end
+
+
+
+
+
+function HandleConsoleNetClient(a_Split)
+ -- Get the address to connect to:
+ local Host = a_Split[3] or "google.com"
+ local Port = a_Split[4] or 80
+
+ -- Create the callbacks "personalised" for the address:
+ local Callbacks =
+ {
+ OnConnected = function (a_Link)
+ LOG("Connected to " .. Host .. ":" .. Port .. ".")
+ LOG("Connection stats: Remote address: " .. a_Link:GetRemoteIP() .. ":" .. a_Link:GetRemotePort() .. ", Local address: " .. a_Link:GetLocalIP() .. ":" .. a_Link:GetLocalPort())
+ LOG("Sending HTTP request for front page.")
+ a_Link:Send("GET / HTTP/1.0\r\nHost: " .. Host .. "\r\n\r\n")
+ end,
+
+ OnError = function (a_Link, a_ErrorCode, a_ErrorMsg)
+ LOG("Connection to " .. Host .. ":" .. Port .. " failed: " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end,
+
+ OnReceivedData = function (a_Link, a_Data)
+ LOG("Received data from " .. Host .. ":" .. Port .. ":\r\n" .. a_Data)
+ end,
+
+ OnRemoteClosed = function (a_Link)
+ LOG("Connection to " .. Host .. ":" .. Port .. " was closed by the remote peer.")
+ end
+ }
+
+ -- Queue a connect request:
+ local res = cNetwork:Connect(Host, Port, Callbacks)
+ if not(res) then
+ LOGWARNING("cNetwork:Connect call failed immediately")
+ return true
+ end
+
+ return true, "Client connection request queued."
+end
+
+
+
+
--
cgit v1.2.3
From 17498a97a289119debdb651ab898ddea99e86ff9 Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Thu, 29 Jan 2015 11:09:56 +0100
Subject: cNetwork: Exported lookup functions to Lua API.
Also added an example in the NetworkTest plugin.
---
MCServer/Plugins/NetworkTest/Info.lua | 21 ++++++++++++++
MCServer/Plugins/NetworkTest/NetworkTest.lua | 42 ++++++++++++++++++++++++++++
2 files changed, 63 insertions(+)
(limited to 'MCServer')
diff --git a/MCServer/Plugins/NetworkTest/Info.lua b/MCServer/Plugins/NetworkTest/Info.lua
index 6bb639860..8c2604e31 100644
--- a/MCServer/Plugins/NetworkTest/Info.lua
+++ b/MCServer/Plugins/NetworkTest/Info.lua
@@ -36,6 +36,27 @@ g_PluginInfo =
},
}, -- ParameterCombinations
}, -- client
+
+ lookup =
+ {
+ HelpString = "Looks up the IP addresses corresponding to the given hostname (google.com by default)",
+ Handler = HandleConsoleNetLookup,
+ ParameterCombinations =
+ {
+ {
+ Params = "",
+ Help = "Looks up the IP addresses of google.com.",
+ },
+ {
+ Params = "Hostname",
+ Help = "Looks up the IP addresses of the specified hostname.",
+ },
+ {
+ Params = "IP",
+ Help = "Looks up the canonical name of the specified IP.",
+ },
+ },
+ }, -- lookup
}, -- Subcommands
}, -- net
},
diff --git a/MCServer/Plugins/NetworkTest/NetworkTest.lua b/MCServer/Plugins/NetworkTest/NetworkTest.lua
index 1a24d4865..30f34c879 100644
--- a/MCServer/Plugins/NetworkTest/NetworkTest.lua
+++ b/MCServer/Plugins/NetworkTest/NetworkTest.lua
@@ -61,3 +61,45 @@ end
+
+function HandleConsoleNetLookup(a_Split)
+ -- Get the name to look up:
+ local Addr = a_Split[3] or "google.com"
+
+ -- Create the callbacks "personalised" for the host:
+ local Callbacks =
+ {
+ OnNameResolved = function (a_Hostname, a_IP)
+ LOG(a_Hostname .. " resolves to " .. a_IP)
+ end,
+
+ OnError = function (a_Query, a_ErrorCode, a_ErrorMsg)
+ LOG("Failed to retrieve information for " .. a_Query .. ": " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ assert(a_Query == Addr)
+ end,
+
+ OnFinished = function (a_Query)
+ LOG("Resolving " .. a_Query .. " has finished.")
+ assert(a_Query == Addr)
+ end,
+ }
+
+ -- Queue both name and IP DNS queries;
+ -- we don't distinguish between an IP and a hostname in this command so we don't know which one to use:
+ local res = cNetwork:HostnameToIP(Addr, Callbacks)
+ if not(res) then
+ LOGWARNING("cNetwork:HostnameToIP call failed immediately")
+ return true
+ end
+ res = cNetwork:IPToHostname(Addr, Callbacks)
+ if not(res) then
+ LOGWARNING("cNetwork:IPToHostname call failed immediately")
+ return true
+ end
+
+ return true, "DNS query has been queued."
+end
+
+
+
+
--
cgit v1.2.3
From 014b96adb33fa902072d9f35661bc4f5e7c323e8 Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Fri, 30 Jan 2015 21:24:02 +0100
Subject: Exported cServerHandle and cNetwork:Listen to Lua.
Also added an example to the NetworkTest plugin.
---
MCServer/Plugins/NetworkTest/Info.lua | 27 ++
MCServer/Plugins/NetworkTest/NetworkTest.lua | 148 ++++++++++-
MCServer/Plugins/NetworkTest/splashes.txt | 357 +++++++++++++++++++++++++++
3 files changed, 531 insertions(+), 1 deletion(-)
create mode 100644 MCServer/Plugins/NetworkTest/splashes.txt
(limited to 'MCServer')
diff --git a/MCServer/Plugins/NetworkTest/Info.lua b/MCServer/Plugins/NetworkTest/Info.lua
index 8c2604e31..f366fd1be 100644
--- a/MCServer/Plugins/NetworkTest/Info.lua
+++ b/MCServer/Plugins/NetworkTest/Info.lua
@@ -37,6 +37,32 @@ g_PluginInfo =
}, -- ParameterCombinations
}, -- client
+ close =
+ {
+ HelpString = "Close a listening socket",
+ Handler = HandleConsoleNetClose,
+ ParameterCombinations =
+ {
+ {
+ Params = "[Port]",
+ Help = "Closes a socket listening on the specified port [1024]",
+ },
+ }, -- ParameterCombinations
+ }, -- close
+
+ listen =
+ {
+ HelpString = "Creates a new listening socket on the specified port with the specified service attached to it",
+ Handler = HandleConsoleNetListen,
+ ParameterCombinations =
+ {
+ {
+ Params = "[Port] [Service]",
+ Help = "Starts listening on the specified port [1024] providing the specified service [echo]",
+ },
+ }, -- ParameterCombinations
+ }, -- listen
+
lookup =
{
HelpString = "Looks up the IP addresses corresponding to the given hostname (google.com by default)",
@@ -57,6 +83,7 @@ g_PluginInfo =
},
},
}, -- lookup
+
}, -- Subcommands
}, -- net
},
diff --git a/MCServer/Plugins/NetworkTest/NetworkTest.lua b/MCServer/Plugins/NetworkTest/NetworkTest.lua
index 30f34c879..9b69ee5b3 100644
--- a/MCServer/Plugins/NetworkTest/NetworkTest.lua
+++ b/MCServer/Plugins/NetworkTest/NetworkTest.lua
@@ -7,11 +7,109 @@
-function Initialize()
+--- Map of all servers currently open
+-- g_Servers[PortNum] = cServerHandle
+local g_Servers = {}
+
+--- List of fortune messages for the fortune server
+-- A random message is chosen for each incoming connection
+-- The contents are loaded from the splashes.txt file on plugin startup
+local g_Fortunes =
+{
+ "Empty splashes.txt",
+}
+
+--- Map of all services that can be run as servers
+-- g_Services[ServiceName] = function() -> callbacks
+local g_Services =
+{
+ -- Echo service: each connection echoes back what has been sent to it
+ echo = function (a_Port)
+ return
+ {
+ -- A new connection has come, give it new link callbacks:
+ OnIncomingConnection = function (a_RemoteIP, a_RemotePort)
+ return
+ {
+ OnError = function (a_Link, a_ErrorCode, a_ErrorMsg)
+ LOG("EchoServer(" .. a_Port .. ": Connection to " .. a_Link:GetRemoteIP() .. ":" .. a_Link:GetRemotePort() .. " failed: " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end,
+
+ OnReceivedData = function (a_Link, a_Data)
+ -- Echo the received data back to the link:
+ a_Link:Send(a_Data)
+ end,
+
+ OnRemoteClosed = function (a_Link)
+ end
+ } -- Link callbacks
+ end, -- OnIncomingConnection()
+
+ -- Send a welcome message to newly accepted connections:
+ OnAccepted = function (a_Link)
+ a_Link:Send("Hello, " .. a_Link:GetRemoteIP() .. ", welcome to the echo server @ MCServer-Lua\r\n")
+ end, -- OnAccepted()
+
+ -- There was an error listening on the port:
+ OnError = function (a_ErrorCode, a_ErrorMsg)
+ LOGINFO("EchoServer(" .. a_Port .. ": Cannot listen: " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end, -- OnError()
+ } -- Listen callbacks
+ end, -- echo
+
+ fortune = function (a_Port)
+ return
+ {
+ -- A new connection has come, give it new link callbacks:
+ OnIncomingConnection = function (a_RemoteIP, a_RemotePort)
+ return
+ {
+ OnError = function (a_Link, a_ErrorCode, a_ErrorMsg)
+ LOG("FortuneServer(" .. a_Port .. ": Connection to " .. a_Link:GetRemoteIP() .. ":" .. a_Link:GetRemotePort() .. " failed: " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end,
+
+ OnReceivedData = function (a_Link, a_Data)
+ -- Ignore any received data
+ end,
+
+ OnRemoteClosed = function (a_Link)
+ end
+ } -- Link callbacks
+ end, -- OnIncomingConnection()
+
+ -- Send a welcome message to newly accepted connections:
+ OnAccepted = function (a_Link)
+ a_Link:Send("Hello, " .. a_Link:GetRemoteIP() .. ", welcome to the fortune server @ MCServer-Lua\r\n\r\nYour fortune:\r\n")
+ a_Link:Send(g_Fortunes[math.random(#g_Fortunes)] .. "\r\n")
+ end, -- OnAccepted()
+
+ -- There was an error listening on the port:
+ OnError = function (a_ErrorCode, a_ErrorMsg)
+ LOGINFO("FortuneServer(" .. a_Port .. ": Cannot listen: " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end, -- OnError()
+ } -- Listen callbacks
+ end, -- fortune
+
+ -- TODO: Other services (fortune, daytime, ...)
+}
+
+
+
+
+
+function Initialize(a_Plugin)
+ -- Load the splashes.txt file into g_Fortunes:
+ for line in io.lines(a_Plugin:GetLocalFolder() .. "/splashes.txt") do
+ table.insert(g_Fortunes, line)
+ end
+
-- Use the InfoReg shared library to process the Info.lua file:
dofile(cPluginManager:GetPluginsPath() .. "/InfoReg.lua")
RegisterPluginInfoCommands()
RegisterPluginInfoConsoleCommands()
+
+ -- Seed the random generator:
+ math.randomseed(os.time())
return true
end
@@ -62,6 +160,26 @@ end
+function HandleConsoleNetClose(a_Split)
+ -- Get the port to close:
+ local Port = tonumber(a_Split[3] or 1024)
+ if not(Port) then
+ return true, "Bad port number: \"" .. Port .. "\"."
+ end
+
+ -- Close the server, if there is one:
+ if not(g_Servers[Port]) then
+ return true, "There is no server currently listening on port " .. Port .. "."
+ end
+ g_Servers[Port]:Close()
+ g_Servers[Port] = nil
+ return true, "Port " .. Port .. " closed."
+end
+
+
+
+
+
function HandleConsoleNetLookup(a_Split)
-- Get the name to look up:
local Addr = a_Split[3] or "google.com"
@@ -103,3 +221,31 @@ end
+
+function HandleConsoleNetListen(a_Split)
+ -- Get the params:
+ local Port = tonumber(a_Split[3] or 1024)
+ if not(Port) then
+ return true, "Invalid port: \"" .. Port .. "\"."
+ end
+ local Service = string.lower(a_Split[4] or "echo")
+
+ -- Create the callbacks specific for the service:
+ if (g_Services[Service] == nil) then
+ return true, "No such service: " .. Service
+ end
+ local Callbacks = g_Services[Service](Port)
+
+ -- Start the server:
+ local srv = cNetwork:Listen(Port, Callbacks)
+ if not(srv:IsListening()) then
+ -- The error message has already been printed in the Callbacks.OnError()
+ return true
+ end
+ g_Servers[Port] = srv
+ return true, Service .. " server started on port " .. Port
+end
+
+
+
+
diff --git a/MCServer/Plugins/NetworkTest/splashes.txt b/MCServer/Plugins/NetworkTest/splashes.txt
new file mode 100644
index 000000000..50a87bd91
--- /dev/null
+++ b/MCServer/Plugins/NetworkTest/splashes.txt
@@ -0,0 +1,357 @@
+As seen on TV!
+Awesome!
+100% pure!
+May contain nuts!
+Better than Prey!
+More polygons!
+Sexy!
+Limited edition!
+Flashing letters!
+Made by Notch!
+It's here!
+Best in class!
+It's finished!
+Kind of dragon free!
+Excitement!
+More than 500 sold!
+One of a kind!
+Heaps of hits on YouTube!
+Indev!
+Spiders everywhere!
+Check it out!
+Holy cow, man!
+It's a game!
+Made in Sweden!
+Uses LWJGL!
+Reticulating splines!
+Minecraft!
+Yaaay!
+Singleplayer!
+Keyboard compatible!
+Undocumented!
+Ingots!
+Exploding creepers!
+That's no moon!
+l33t!
+Create!
+Survive!
+Dungeon!
+Exclusive!
+The bee's knees!
+Down with O.P.P.!
+Closed source!
+Classy!
+Wow!
+Not on steam!
+Oh man!
+Awesome community!
+Pixels!
+Teetsuuuuoooo!
+Kaaneeeedaaaa!
+Now with difficulty!
+Enhanced!
+90% bug free!
+Pretty!
+12 herbs and spices!
+Fat free!
+Absolutely no memes!
+Free dental!
+Ask your doctor!
+Minors welcome!
+Cloud computing!
+Legal in Finland!
+Hard to label!
+Technically good!
+Bringing home the bacon!
+Indie!
+GOTY!
+Ceci n'est pas une title screen!
+Euclidian!
+Now in 3D!
+Inspirational!
+Herregud!
+Complex cellular automata!
+Yes, sir!
+Played by cowboys!
+OpenGL 2.1 (if supported)!
+Thousands of colors!
+Try it!
+Age of Wonders is better!
+Try the mushroom stew!
+Sensational!
+Hot tamale, hot hot tamale!
+Play him off, keyboard cat!
+Guaranteed!
+Macroscopic!
+Bring it on!
+Random splash!
+Call your mother!
+Monster infighting!
+Loved by millions!
+Ultimate edition!
+Freaky!
+You've got a brand new key!
+Water proof!
+Uninflammable!
+Whoa, dude!
+All inclusive!
+Tell your friends!
+NP is not in P!
+Notch <3 ez!
+Music by C418!
+Livestreamed!
+Haunted!
+Polynomial!
+Terrestrial!
+All is full of love!
+Full of stars!
+Scientific!
+Cooler than Spock!
+Collaborate and listen!
+Never dig down!
+Take frequent breaks!
+Not linear!
+Han shot first!
+Nice to meet you!
+Buckets of lava!
+Ride the pig!
+Larger than Earth!
+sqrt(-1) love you!
+Phobos anomaly!
+Punching wood!
+Falling off cliffs!
+0% sugar!
+150% hyperbole!
+Synecdoche!
+Let's danec!
+Seecret Friday update!
+Reference implementation!
+Lewd with two dudes with food!
+Kiss the sky!
+20 GOTO 10!
+Verlet intregration!
+Peter Griffin!
+Do not distribute!
+Cogito ergo sum!
+4815162342 lines of code!
+A skeleton popped out!
+The Work of Notch!
+The sum of its parts!
+BTAF used to be good!
+I miss ADOM!
+umop-apisdn!
+OICU812!
+Bring me Ray Cokes!
+Finger-licking!
+Thematic!
+Pneumatic!
+Sublime!
+Octagonal!
+Une baguette!
+Gargamel plays it!
+Rita is the new top dog!
+SWM forever!
+Representing Edsbyn!
+Matt Damon!
+Supercalifragilisticexpialidocious!
+Consummate V's!
+Cow Tools!
+Double buffered!
+Fan fiction!
+Flaxkikare!
+Jason! Jason! Jason!
+Hotter than the sun!
+Internet enabled!
+Autonomous!
+Engage!
+Fantasy!
+DRR! DRR! DRR!
+Kick it root down!
+Regional resources!
+Woo, facepunch!
+Woo, somethingawful!
+Woo, /v/!
+Woo, tigsource!
+Woo, minecraftforum!
+Woo, worldofminecraft!
+Woo, reddit!
+Woo, 2pp!
+Google anlyticsed!
+Now supports åäö!
+Give us Gordon!
+Tip your waiter!
+Very fun!
+12345 is a bad password!
+Vote for net neutrality!
+Lives in a pineapple under the sea!
+MAP11 has two names!
+Omnipotent!
+Gasp!
+...!
+Bees, bees, bees, bees!
+Jag känner en bot!
+This text is hard to read if you play the game at the default resolution, but at 1080p it's fine!
+Haha, LOL!
+Hampsterdance!
+Switches and ores!
+Menger sponge!
+idspispopd!
+Eple (original edit)!
+So fresh, so clean!
+Slow acting portals!
+Try the Nether!
+Don't look directly at the bugs!
+Oh, ok, Pigmen!
+Finally with ladders!
+Scary!
+Play Minecraft, Watch Topgear, Get Pig!
+Twittered about!
+Jump up, jump up, and get down!
+Joel is neat!
+A riddle, wrapped in a mystery!
+Huge tracts of land!
+Welcome to your Doom!
+Stay a while, stay forever!
+Stay a while and listen!
+Treatment for your rash!
+"Autological" is!
+Information wants to be free!
+"Almost never" is an interesting concept!
+Lots of truthiness!
+The creeper is a spy!
+Turing complete!
+It's groundbreaking!
+Let our battle's begin!
+The sky is the limit!
+Jeb has amazing hair!
+Ryan also has amazing hair!
+Casual gaming!
+Undefeated!
+Kinda like Lemmings!
+Follow the train, CJ!
+Leveraging synergy!
+This message will never appear on the splash screen, isn't that weird?
+DungeonQuest is unfair!
+110813!
+90210!
+Check out the far lands!
+Tyrion would love it!
+Also try VVVVVV!
+Also try Super Meat Boy!
+Also try Terraria!
+Also try Mount And Blade!
+Also try Project Zomboid!
+Also try World of Goo!
+Also try Limbo!
+Also try Pixeljunk Shooter!
+Also try Braid!
+That's super!
+Bread is pain!
+Read more books!
+Khaaaaaaaaan!
+Less addictive than TV Tropes!
+More addictive than lemonade!
+Bigger than a bread box!
+Millions of peaches!
+Fnord!
+This is my true form!
+Totally forgot about Dre!
+Don't bother with the clones!
+Pumpkinhead!
+Hobo humping slobo babe!
+Made by Jeb!
+Has an ending!
+Finally complete!
+Feature packed!
+Boots with the fur!
+Stop, hammertime!
+Testificates!
+Conventional!
+Homeomorphic to a 3-sphere!
+Doesn't avoid double negatives!
+Place ALL the blocks!
+Does barrel rolls!
+Meeting expectations!
+PC gaming since 1873!
+Ghoughpteighbteau tchoghs!
+Déjà vu!
+Déjà vu!
+Got your nose!
+Haley loves Elan!
+Afraid of the big, black bat!
+Doesn't use the U-word!
+Child's play!
+See you next Friday or so!
+From the streets of Södermalm!
+150 bpm for 400000 minutes!
+Technologic!
+Funk soul brother!
+Pumpa kungen!
+日本ハロー!
+한국 안녕하세요!
+Helo Cymru!
+Cześć Polsko!
+你好中国!
+Привет Россия!
+Γεια σου Ελλάδα!
+My life for Aiur!
+Lennart lennart = new Lennart();
+I see your vocabulary has improved!
+Who put it there?
+You can't explain that!
+if not ok then return end
+§1C§2o§3l§4o§5r§6m§7a§8t§9i§ac
+§kFUNKY LOL
+SOPA means LOSER in Swedish!
+Big Pointy Teeth!
+Bekarton guards the gate!
+Mmmph, mmph!
+Don't feed avocados to parrots!
+Swords for everyone!
+Plz reply to my tweet!
+.party()!
+Take her pillow!
+Put that cookie down!
+Pretty scary!
+I have a suggestion.
+Now with extra hugs!
+Now Java 6!
+Woah.
+HURNERJSGER?
+What's up, Doc?
+Now contains 32 random daily cats!
+That's Numberwang!
+pls rt
+Do you want to join my server?
+Put a little fence around it!
+Throw a blanket over it!
+One day, somewhere in the future, my work will be quoted!
+Now with additional stuff!
+Extra things!
+Yay, puppies for everyone!
+So sweet, like a nice bon bon!
+Popping tags!
+Very influential in its circle!
+Now With Multiplayer!
+Rise from your grave!
+Warning! A huge battleship "STEVE" is approaching fast!
+Blue warrior shot the food!
+Run, coward! I hunger!
+Flavor with no seasoning!
+Strange, but not a stranger!
+Tougher than diamonds, rich like cream!
+Getting ready to show!
+Getting ready to know!
+Getting ready to drop!
+Getting ready to shock!
+Getting ready to freak!
+Getting ready to speak!
+It swings, it jives!
+Cruising streets for gold!
+Take an eggbeater and beat it against a skillet!
+Make me a table, a funky table!
+Take the elevator to the mezzanine!
+Stop being reasonable, this is the Internet!
+/give @a hugs 64
+This is good for Realms.
+Any computer is a laptop if you're brave enough!
\ No newline at end of file
--
cgit v1.2.3
From d1c9ce2a03772a8c00c29450b0ba7a30d2aacadd Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Wed, 4 Feb 2015 10:39:48 +0100
Subject: NetworkTest plugin: updated comments and splash loading.
---
MCServer/Plugins/NetworkTest/NetworkTest.lua | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
(limited to 'MCServer')
diff --git a/MCServer/Plugins/NetworkTest/NetworkTest.lua b/MCServer/Plugins/NetworkTest/NetworkTest.lua
index 9b69ee5b3..7932f4b88 100644
--- a/MCServer/Plugins/NetworkTest/NetworkTest.lua
+++ b/MCServer/Plugins/NetworkTest/NetworkTest.lua
@@ -20,14 +20,14 @@ local g_Fortunes =
}
--- Map of all services that can be run as servers
--- g_Services[ServiceName] = function() -> callbacks
+-- g_Services[ServiceName] = function() -> accept-callbacks
local g_Services =
{
-- Echo service: each connection echoes back what has been sent to it
echo = function (a_Port)
return
{
- -- A new connection has come, give it new link callbacks:
+ -- A new connection has come, give it new link-callbacks:
OnIncomingConnection = function (a_RemoteIP, a_RemotePort)
return
{
@@ -57,10 +57,11 @@ local g_Services =
} -- Listen callbacks
end, -- echo
+ -- Fortune service: each incoming connection gets a welcome message plus a random fortune text; all communication is ignored afterwards
fortune = function (a_Port)
return
{
- -- A new connection has come, give it new link callbacks:
+ -- A new connection has come, give it new link-callbacks:
OnIncomingConnection = function (a_RemoteIP, a_RemotePort)
return
{
@@ -77,7 +78,7 @@ local g_Services =
} -- Link callbacks
end, -- OnIncomingConnection()
- -- Send a welcome message to newly accepted connections:
+ -- Send a welcome message and the fortune to newly accepted connections:
OnAccepted = function (a_Link)
a_Link:Send("Hello, " .. a_Link:GetRemoteIP() .. ", welcome to the fortune server @ MCServer-Lua\r\n\r\nYour fortune:\r\n")
a_Link:Send(g_Fortunes[math.random(#g_Fortunes)] .. "\r\n")
@@ -90,7 +91,7 @@ local g_Services =
} -- Listen callbacks
end, -- fortune
- -- TODO: Other services (fortune, daytime, ...)
+ -- TODO: Other services (daytime, ...)
}
@@ -98,9 +99,11 @@ local g_Services =
function Initialize(a_Plugin)
- -- Load the splashes.txt file into g_Fortunes:
+ -- Load the splashes.txt file into g_Fortunes, overwriting current content:
+ local idx = 1
for line in io.lines(a_Plugin:GetLocalFolder() .. "/splashes.txt") do
- table.insert(g_Fortunes, line)
+ g_Fortunes[idx] = line
+ idx = idx + 1
end
-- Use the InfoReg shared library to process the Info.lua file:
--
cgit v1.2.3
From adf0020cd41f6a947ef883c582dde74d67255b1f Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Fri, 6 Feb 2015 18:44:05 +0100
Subject: APIDump: Added cNetwork documentation.
---
MCServer/Plugins/APIDump/Classes/Network.lua | 183 +++++++++++++++++++++++++++
1 file changed, 183 insertions(+)
create mode 100644 MCServer/Plugins/APIDump/Classes/Network.lua
(limited to 'MCServer')
diff --git a/MCServer/Plugins/APIDump/Classes/Network.lua b/MCServer/Plugins/APIDump/Classes/Network.lua
new file mode 100644
index 000000000..2f1880a52
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Classes/Network.lua
@@ -0,0 +1,183 @@
+
+-- Network.lua
+
+-- Defines the documentation for the cNetwork-related classes
+
+
+
+
+
+return
+{
+ cNetwork =
+ {
+ Desc =
+ [[
+ This is the namespace for high-level network-related operations. Allows plugins to make TCP
+ connections to the outside world using a callback-based API.
+
+ All functions in this namespace are static, they should be called on the cNetwork class itself:
+
+local Server = cNetwork:Listen(1024, ListenCallbacks);
+
+ ]],
+ AdditionalInfo =
+ {
+ {
+ Header = "Using callbacks",
+ Contents =
+ [[
+ The entire Networking API is callback-based. Whenever an event happens on the network object, a
+ specific plugin-provided function is called. The callbacks are stored in tables which are passed
+ to the API functions, each table contains multiple callbacks for the various situations.
+
+ There are three different callback variants used: LinkCallbacks, LookupCallbacks and
+ ListenCallbacks. Each is used in the situation appropriate by its name - LinkCallbacks are used
+ for handling the traffic on a single network link (plus additionally creation of such link when
+ connecting as a client), LookupCallbacks are used when doing DNS and reverse-DNS lookups, and
+ ListenCallbacks are used for handling incoming connections as a server.
+
+ LinkCallbacks have the following structure:
+
+local LinkCallbacks =
+{
+ OnConnected = function ({{cTCPLink|a_TCPLink}})
+ -- The specified {{cTCPLink|link}} has succeeded in connecting to the remote server.
+ -- Only called if the link is being connected as a client (using cNetwork:Connect() )
+ -- Not used for incoming server links
+ -- All returned values are ignored
+ end,
+
+ OnError = function ({{cTCPLink|a_TCPLink}}, a_ErrorCode, a_ErrorMsg)
+ -- The specified error has occured on the {{cTCPLink|link}}
+ -- No other callback will be called for this link from now on
+ -- For a client link being connected, this reports a connection error (destination unreachable etc.)
+ -- It is an Undefined Behavior to send data to a_TCPLink in or after this callback
+ -- All returned values are ignored
+ end,
+
+ OnReceivedData = function ({{cTCPLink|a_TCPLink}}, a_Data)
+ -- Data has been received on the {{cTCPLink|link}}
+ -- Will get called whenever there's new data on the {{cTCPLink|link}}
+ -- a_Data contains the raw received data, as a string
+ -- All returned values are ignored
+ end,
+
+ OnRemoteClosed = function ({{cTCPLink|a_TCPLink}})
+ -- The remote peer has closed the {{cTCPLink|link}}
+ -- The link is already closed, any data sent to it now will be lost
+ -- No other callback will be called for this link from now on
+ -- All returned values are ignored
+ end,
+}
+
+
+ LookupCallbacks have the following structure:
+
+local LookupCallbacks =
+{
+ OnError = function (a_Query, a_ErrorCode, a_ErrorMsg)
+ -- The specified error has occured while doing the lookup
+ -- a_Query is the hostname or IP being looked up
+ -- No other callback will be called for this lookup from now on
+ -- All returned values are ignored
+ end,
+
+ OnFinished = function (a_Query)
+ -- There are no more DNS records for this query
+ -- a_Query is the hostname or IP being looked up
+ -- No other callback will be called for this lookup from now on
+ -- All returned values are ignored
+ end,
+
+ OnNameResolved = function (a_Hostname, a_IP)
+ -- A DNS record has been found, the specified hostname resolves to the IP
+ -- Called for both Hostname -> IP and IP -> Hostname lookups
+ -- May be called multiple times if a hostname resolves to multiple IPs
+ -- All returned values are ignored
+ end,
+}
+
+
+ ListenCallbacks have the following structure:
+
+local ListenCallbacks =
+{
+ OnAccepted = function ({{cTCPLink|a_TCPLink}})
+ -- A new connection has been accepted and a {{cTCPLink|Link}} for it created
+ -- It is safe to send data to the link now
+ -- All returned values are ignored
+ end,
+
+ OnError = function (a_ErrorCode, a_ErrorMsg)
+ -- The specified error has occured while trying to listen
+ -- No other callback will be called for this lookup from now on
+ -- This callback is called before the cNetwork:Listen() call returns
+ -- All returned values are ignored
+ end,
+
+ OnIncomingConnection = function (a_RemoteIP, a_RemotePort, a_LocalPort)
+ -- A new connection is being accepted, from the specified remote peer
+ -- This function needs to return either nil to drop the connection,
+ -- or valid LinkCallbacks to use for the new connection's {{cTCPLink|TCPLink}} object
+ return SomeLinkCallbacks
+ end,
+}
+
+ ]],
+ },
+ }, -- AdditionalInfo
+
+ Functions =
+ {
+ Connect = { Params = "Host, Port, LinkCallbacks", Return = "bool", Notes = "(STATIC) Begins establishing a (client) TCP connection to the specified host. Uses the LinkCallbacks table to report progress, success, errors and incoming data. Returns false if it fails immediately (bad port value, bad hostname format), true otherwise. Host can be either an IP address or a hostname." },
+ HostnameToIP = { Params = "Host, LookupCallbacks", Return = "bool", Notes = "(STATIC) Begins a DNS lookup to find the IP address(es) for the specified host. Uses the LookupCallbacks table to report progress, success or errors. Returns false if it fails immediately (bad hostname format), true if the lookup started successfully. Host can be either a hostname or an IP address." },
+ IPToHostname = { Params = "Address, LookupCallbacks", Return = "bool", Notes = "(STATIC) Begins a reverse-DNS lookup to find out the hostname for the specified IP address. Uses the LookupCallbacks table to report progress, success or errors. Returns false if it fails immediately (bad address format), true if the lookup started successfully." },
+ Listen = { Params = "Port, ListenCallbacks", Return = "{{cServerHandle|ServerHandle}}", Notes = "(STATIC) Starts listening on the specified port. Uses the ListenCallbacks to report incoming connections or errors. Returns a {{cServerHandle}} object representing the server. If the listen operation failed, the OnError callback is called with the error details and the returned server handle will report IsListening() == false. The plugin needs to store the server handle object for as long as it needs the server running, if the server handle is garbage-collected by Lua, the listening socket will be closed and all current connections dropped." },
+ },
+ }, -- cNetwork
+
+ cTCPLink =
+ {
+ Desc =
+ [[
+ This class wraps a single TCP connection, that has been established. Plugins can create these by
+ calling {{cNetwork}}:Connect() to connect to a remote server, or by listening using
+ {{cNetwork}}:Listen() and accepting incoming connections. The links are callback-based - when an event
+ such as incoming data or remote disconnect happens on the link, a specific callback is called. See the
+ additional information in {{cNetwork}} documentation for details.
+ ]],
+
+ Functions =
+ {
+ GetLocalIP = { Params = "", Return = "string", Notes = "Returns the IP address of the local endpoint of the TCP connection." },
+ GetLocalPort = { Params = "", Return = "number", Notes = "Returns the port of the local endpoint of the TCP connection." },
+ GetRemoteIP = { Params = "", Return = "string", Notes = "Returns the IP address of the remote endpoint of the TCP connection." },
+ GetRemotePort = { Params = "", Return = "number", Notes = "Returns the port of the remote endpoint of the TCP connection." },
+ Send = { Params = "Data", Return = "", Notes = "Sends the data (raw string) to the remote peer. The data is sent asynchronously and there is no report on the success of the send operation, other than the connection being closed or reset by the underlying OS." },
+ },
+ }, -- cTCPLink
+
+ cServerHandle =
+ {
+ Desc =
+ [[
+ This class provides an interface for TCP sockets listening for a connection. In order to listen, the
+ plugin needs to use the {{cNetwork}}:Listen() function to create the listening socket.
+
+ Note that when Lua garbage-collects this class, the listening socket is closed. Therefore the plugin
+ should keep it referenced in a global variable for as long as it wants the server running.
+ ]],
+
+ Functions =
+ {
+ Close = { Params = "", Return = "", Notes = "Closes the listening socket. No more connections will be accepted, and all current connections will be closed." },
+ IsListening = { Params = "", Return = "bool", Notes = "Returns true if the socket is listening." },
+ },
+
+ }, -- cServerHandle
+}
+
+
+
+
--
cgit v1.2.3
From 43b68975f7a2491ee9c0702f1d2fe01d78bb8a8e Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Sat, 7 Feb 2015 13:30:45 +0100
Subject: APIDump: Added client and server examples.
---
MCServer/Plugins/APIDump/Classes/Network.lua | 137 +++++++++++++++++++++++++++
1 file changed, 137 insertions(+)
(limited to 'MCServer')
diff --git a/MCServer/Plugins/APIDump/Classes/Network.lua b/MCServer/Plugins/APIDump/Classes/Network.lua
index 2f1880a52..065a743d8 100644
--- a/MCServer/Plugins/APIDump/Classes/Network.lua
+++ b/MCServer/Plugins/APIDump/Classes/Network.lua
@@ -126,6 +126,143 @@ local ListenCallbacks =
]],
},
+
+ {
+ Header = "Example client connection",
+ Contents =
+ [[
+ The following example, adapted from the NetworkTest plugin, shows a simple example of a client
+ connection using the cNetwork API. It connects to www.google.com on port 80 (http) and sends a http
+ request for the front page. It dumps the received data to the console.
+
+ First, the callbacks are defined in a table. The OnConnected() callback takes care of sending the http
+ request once the socket is connected. The OnReceivedData() callback sends all data to the console. The
+ OnError() callback logs any errors. Then, the connection is initiated using the cNetwork::Connect() API
+ function.
+
+
+-- Define the callbacks to use for the client connection:
+local ConnectCallbacks =
+{
+ OnConnected = function (a_Link)
+ -- Connection succeeded, send the http request:
+ a_Link:Send("GET / HTTP/1.0\r\nHost: www.google.com\r\n\r\n")
+ end,
+
+ OnError = function (a_Link, a_ErrorCode, a_ErrorMsg)
+ -- Log the error to console:
+ LOG("An error has occurred while talking to google.com: " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end,
+
+ OnReceivedData = function (a_Link, a_Data)
+ -- Log the received data to console:
+ LOG("Incoming http data:\r\n" .. a_Data)
+ end,
+
+ OnRemoteClosed = function (a_Link)
+ -- Log the event into the console:
+ LOG("Connection to www.google.com closed")
+ end,
+}
+
+-- Connect:
+if not(cNetwork:Connect("www.google.com", 80, ConnectCallbacks)) then
+ -- Highly unlikely, but better check for errors
+ LOG("Cannot queue connection to www.google.com")
+end
+-- Note that the connection is being made on the background,
+-- there's no guarantee that it's already connected at this point in code
+
+ ]],
+ },
+
+ {
+ Header = "Example server implementation",
+ Contents =
+ [[
+ The following example, adapted from the NetworkTest plugin, shows a simple example of creating a
+ server listening on a TCP port using the cNetwork API. The server listens on port 9876 and for
+ each incoming connection it sends a welcome message and then echoes back whatever the client has
+ sent ("echo server").
+
+ First, the callbacks for the listening server are defined. The most important of those is the
+ OnIncomingConnection() callback that must return the LinkCallbacks that will be used for the new
+ connection. In our simple scenario each connection uses the same callbacks, so a predefined
+ callbacks table is returned; it is, however, possible to define different callbacks for each
+ connection. This allows the callbacks to be "personalised", for example by the remote IP or the
+ time of connection. The OnAccepted() and OnError() callbacks only log that they occurred, there's
+ no processing needed for them.
+
+ Finally, the cNetwork:Listen() API function is used to create the listening server. The status of
+ the server is checked and if it is successfully listening, it is stored in a global variable, so
+ that Lua doesn't garbage-collect it until we actually want the server closed.
+
+
+-- Define the callbacks used for the incoming connections:
+local EchoLinkCallbacks =
+{
+ OnConnected = function (a_Link)
+ -- This will not be called for a server connection, ever
+ assert(false, "Unexpected Connect callback call")
+ end,
+
+ OnError = function (a_Link, a_ErrorCode, a_ErrorMsg)
+ -- Log the error to console:
+ local RemoteName = "'" .. a_Link:GetRemoteIP() .. ":" .. a_Link:GetRemotePort() .. "'"
+ LOG("An error has occurred while talking to " .. RemoteName .. ": " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")")
+ end,
+
+ OnReceivedData = function (a_Link, a_Data)
+ -- Send the received data back to the remote peer
+ a_Link:Send(Data)
+ end,
+
+ OnRemoteClosed = function (a_Link)
+ -- Log the event into the console:
+ local RemoteName = "'" .. a_Link:GetRemoteIP() .. ":" .. a_Link:GetRemotePort() .. "'"
+ LOG("Connection to '" .. RemoteName .. "' closed")
+ end,
+}
+
+-- Define the callbacks used by the server:
+local ListenCallbacks =
+{
+ OnAccepted = function (a_Link)
+ -- No processing needed, just log that this happened:
+ LOG("OnAccepted callback called")
+ end,
+
+ OnError = function (a_ErrorCode, a_ErrorMsg)
+ -- An error has occured while listening for incoming connections, log it:
+ LOG("Cannot listen, error " .. a_ErrorCode .. " (" .. a_ErrorMsg .. ")"
+ end,
+
+ OnIncomingConnection = function (a_RemoteIP, a_RemotePort, a_LocalPort)
+ -- A new connection is being accepted, give it the EchoCallbacks
+ return EchoLinkCallbacks
+ end,
+}
+
+-- Start the server:
+local Server = cNetwork:Listen(9876, ListenCallbacks)
+if not(Server:IsListening()) then
+ -- The error has been already printed in the OnError() callbacks
+ -- Just bail out
+ return;
+end
+
+-- Store the server globally, so that it stays open:
+g_Server = Server
+
+...
+
+-- Elsewhere in the code, when terminating:
+-- Close the server and let it be garbage-collected:
+g_Server:Close()
+g_Server = nil
+
+ ]],
+ },
}, -- AdditionalInfo
Functions =
--
cgit v1.2.3