Manual:Networking Functions - Revision history

Tamarindo: /* openIRC */

2026-02-04T02:56:25Z

openIRC

Atari2600tim: /* sendGMCP */ new location for IRE GMCP info

2025-06-28T02:43:04Z

sendGMCP: new location for IRE GMCP info

Atari2600tim: /* getHTTP */ http://postman-echo.com -> https://postman-echo.com

2025-06-25T19:31:47Z

getHTTP: http://postman-echo.com -> https://postman-echo.com

Atari2600tim: /* postHTTP */ postman-echo now uses https instead of http apparently

2025-06-25T19:30:52Z

postHTTP: postman-echo now uses https instead of http apparently

Slysven: /* feedTelnet */ Add some details to token table and correct error in last entry

2025-04-27T02:12:30Z

feedTelnet: Add some details to token table and correct error in last entry

Vadi: /* feedTelnet */

2024-12-26T08:05:29Z

feedTelnet

Vadi at 08:04, 26 December 2024

2024-12-26T08:04:43Z

Show changes

Vadi: /* sendSocket */

2024-12-26T07:51:15Z

sendSocket

Vadi at 07:49, 26 December 2024

2024-12-26T07:49:45Z

Vadi: moved sendSocket

2024-12-24T09:08:31Z

moved sendSocket

@@ Line 183: / Line 183: @@
 end
 </syntaxhighlight>
 ==openUrl==

@@ Line 245: / Line 245: @@
 ==sendGMCP==
 ;sendGMCP(command)
-: Sends a GMCP message to the server.  The [http://www.ironrealms.com/gmcp-doc IRE document on GMCP] has information about what can be sent, and what tables it will use, etcetera.
+: Sends a GMCP message to the server.  The [https://nexus.ironrealms.com/GMCP IRE document on GMCP] has information about what can be sent, and what tables it will use, etcetera.
 : Note that this function is rarely used in practice. For most GMCP modules, the messages are automatically sent by the server when a relevant event happens in the game. For example, LOOKing in your room prompts the server to send the room description and contents, as well as the GMCP message gmcp.Room. A call to sendGMCP would not be required in this case.

@@ Line 502: / Line 502: @@
 <syntaxhighlight lang="lua">
 -- Status requests typically use GET requests
-local url = "http://postman-echo.com/status"
+local url = "https://postman-echo.com/status"
 local header = {["Content-Type"] = "application/json"}

@@ Line 555: / Line 555: @@
 <syntaxhighlight lang="lua">
 -- This will create a JSON message body. Many modern REST APIs expect a JSON body.
-local url = "http://postman-echo.com/post"
+local url = "https://postman-echo.com/post"
 local data = {message = "I am the banana", user = "admin"}
 local header = {["Content-Type"] = "application/json"}
@@ Line 638: / Line 638: @@
      ["Authorization"] = "Basic " .. base64Encode("user:12345")
+}
-postJSON("http://postman-echo.com/post",data,header)
+postJSON("https://postman-echo.com/post",data,header)
 </syntaxhighlight>

@@ Line 861: / Line 861: @@
 || <05> || \x05 || 1 ||
 |-
-|| <O_STATUS> || \x05 || 1 ||
+|| <O_STATUS> || \x05 || 1 || Telnet option: Status
 |-
 || <ENQ> || \x05 || 1 || ASCII control character: Enquiry
@@ Line 875: / Line 875: @@
 || <08> || \x08 || 1 || Telnet option: Output Line Width
 |-
-|| <BS> || \x08 || 1 ||
+|| <BS> || \x08 || 1 || ASCII control character: Backspace
 |-
 || <09> || \x09 || 1 || Telnet option: Output Page Size
@@ Line 987: / Line 987: @@
 || <O_MSSP> || \x46 || 1 || 70 dec. Telnet option: Mud Server Status Protocol
 |-
-|| <O_MCCP> || \x55 || 1 || 85 dec
+|| <O_MCCP> || \x55 || 1 || 85 dec. Telnet option: Mud Client Compression Protocol
 |-
-|| <O_MCCP2> || \x56 || 1 || 86 dec
+|| <O_MCCP2> || \x56 || 1 || 86 dec. Telnet option: Mud Client Compression Protocol 2
 |-
 || <O_MSP> || \x5a || 1 || 90 dec. Telnet option: Mud Sound Protocol
@@ Line 1,001: / Line 1,001: @@
 || <nowiki><DEL></nowiki> || \x7f || 1 || 127 dec. ASCII control character: Delete
 |-
-|| <O_ATCP> || \xc8 || 1 || 200 dec
+|| <O_ATCP> || \xc8 || 1 || 200 dec. Telnet option: Achaea Telnet Client Protocol
 |-
-|| <O_GMCP> || \xc9 || 1 || 201 dec
+|| <O_GMCP> || \xc9 || 1 || 201 dec. Telnet option: Generic Mud Communication Protocol
 |-
-|| <T_EOR> || \xef || 1 || 239 dec
+|| <T_EOR> || \xef || 1 || 239 dec. Telnet protocol: End Of Record
 |-
 || <F0> || \xf0 || 1 ||
 |-
-|| <T_SE> || \xf0 || 1 ||
+|| <T_SE> || \xf0 || 1 || 240 dec. Telnet protocol: End Of Sub Option
 |-
 || <F1> || \xf1 || 1 ||
 |-
-|| <T_NOP> || \xf1 || 1 ||
+|| <T_NOP> || \xf1 || 1 || 241 dec. Telnet protocol: No Operation
 |-
 || <F2> || \xf2 || 1 ||
 |-
-|| <T_DM> || \xf2 || 1 ||
+|| <T_DM> || \xf2 || 1 || 242 dec. Telnet protocol: Data Mark
 |-
 || <F3> || \xf3 || 1 ||
 |-
-|| <T_BRK> || \xf3 || 1 ||
+|| <T_BRK> || \xf3 || 1 || 243 dec. Telnet protocol: Break
 |-
 || <F4> || \xf4 || 1 ||
 |-
-|| <T_IP> || \xf4 || 1 ||
+|| <T_IP> || \xf4 || 1 || 244 dec. Telnet protocol: Interrupt Process
 |-
 || <F5> || \xf5 || 1 ||
 |-
-|| <T_ABOP> || \xf5 || 1 ||
+|| <T_ABOP> || \xf5 || 1 || 245 dec. Telnet protocol: Abort Output
 |-
 || <F6> || \xf6 || 1 ||
 |-
-|| <T_AYT> || \xf6 || 1 ||
+|| <T_AYT> || \xf6 || 1 || 246 dec. Telnet protocol: Are You There?
 |-
 || <F7> || \xf7 || 1 ||
 |-
-|| <T_EC> || \xf7 || 1 ||
+|| <T_EC> || \xf7 || 1 || 247 dec. Telnet protocol: Erase Character
 |-
 || <F8> || \xf8 || 1 ||
 |-
-|| <T_EL> || \xf8 || 1 ||
+|| <T_EL> || \xf8 || 1 || 248 dec. Telnet protocol: Erase Line
 |-
 || <F9> || \xf9 || 1 ||
 |-
-|| <T_GA> || \xf9 || 1 ||
+|| <T_GA> || \xf9 || 1 || 249 dec. Telnet protocol: Go Ahead
 |-
 || <FA> || \xfa || 1 ||
 |-
-|| <T_SB> || \xfa || 1 ||
+|| <T_SB> || \xfa || 1 || 250 dec. Telnet protocol: Start Of Sub Option
 |-
 || <FB> || \xfb || 1 ||
 |-
-|| <T_WILL> || \xfb || 1 ||
+|| <T_WILL> || \xfb || 1 || 251 dec. Telnet protocol: Sender Will Option
 |-
 || <FC> || \xfc || 1 ||
 |-
-|| <T_WONT> || \xfc || 1 ||
+|| <T_WONT> || \xfc || 1 || 252 dec. Telnet protocol: Sender Will Not Option
 |-
 || <FD> || \xfd || 1 ||
 |-
-|| <T_DO> || \xfd || 1 ||
+|| <T_DO> || \xfd || 1 || 253 dec. Telnet protocol: Receiver To Do Option
 |-
 || <FE> || \xfe || 1 ||
 |-
-|| <T_DONT> || \xfe || 1 ||
+|| <T_DONT> || \xfe || 1 || 254 dec. Telnet protocol: Receiver Not To Do Option
 |-
-|| <FF> || \xff || 1 ||
+|| <FF> || \xff || 1 || Telnet option: Extended Option
 |-
-|| <T_IAC> || \xff'
+|| <T_IAC> || \xff || 1 || 255 dec. Telnet protocol: Interpret (Next Byte) As (A Protocol) Command
 |}

@@ Line 817: / Line 817: @@
 ;See also: [[Manual:Lua_Functions#feedTriggers|feedTriggers()]], [[Manual:Lua_Functions#sendSocket|sendSocket()]]
-{{MudletVersion|tbd}}
+{{MudletVersion|4.18.0}}
 {{note}} This is not really intended for end-user's but might be useful in some circumstances.

@@ Line 384: / Line 384: @@
 ;See also: [[Manual:Lua_Functions#feedTelnet|feedTelnet()]], [[Manual:Lua_Functions#feedTriggers|feedTriggers()]]
-{{note}} Modified in Mudlet '''tbd''' to accept some tokens like "''<NUL>''" to include byte values that are not possible to insert with the standard Lua string escape "''\###''" form where ### is a three digit number between 000 and 255 inclusive or where the value is more easily provided via a mnemonic. For the table of the tokens that are known about, see the one in [[Manual:Lua_Functions#feedTelnet|feedTelnet()]].
+{{note}} Modified in Mudlet 4.19.0 to accept some tokens like "''<NUL>''" to include byte values that are not possible to insert with the standard Lua string escape "''\###''" form where ### is a three digit number between 000 and 255 inclusive or where the value is more easily provided via a mnemonic. For the table of the tokens that are known about, see the one in [[Manual:Lua_Functions#feedTelnet|feedTelnet()]].
 {{note}} The data (as bytes) once the tokens have been converted to their byte values is sent as is to the Game Server; any encoding to, say, a UTF-8 representation or to duplicate ''0xff'' byte values so they are not considered to be Telnet ''<IAC>'' (Interpret As Command) bytes must be done to the data prior to calling this function.
@@ Line 393: / Line 393: @@
 ;Returns
-* (Only since Mudlet '''tbd''') Boolean ''true'' if the whole data string (after token replacement) was sent to the Server, ''false'' if that failed for any reason (including if the Server has not been connected or is now disconnected). ''nil'' and an error message for any other defect.
+* (Only since Mudlet 4.19.0) Boolean ''true'' if the whole data string (after token replacement) was sent to the Server, ''false'' if that failed for any reason (including if the Server has not been connected or is now disconnected). ''nil'' and an error message for any other defect.
 ;Example

@@ Line 211: / Line 211: @@
 ==sendAll==
 ; sendAll(list of things to send, [echo back or not])
-: sends multiple things to the game. If you'd like the commands not to be shown, include ''false'' at the end.
+; sendAll([time delay], list of things to send, [echo back or not])
 :See also: [[Manual:Basic_Essentials#send|send()]]
@@ Line 222: / Line 223: @@
 -- can also have the commands not be echoed
 sendAll("hi", "bye", false)
 </syntaxhighlight>
@@ Line 370: / Line 374: @@
 ==sendSocket==
 ;sendSocket(data)
-:Sends given binary data as-is to the game. You can use this to implement support for a [[Manual:Supported_Protocols#Adding_support_for_a_telnet_protocol|new telnet protocol]], [http://forums.mudlet.org/viewtopic.php?f=5&t=2272 simultronics] [http://forums.mudlet.org/viewtopic.php?f=5&t=2213#p9810 login] or etcetera.
+:Sends given binary data as-is (or with some predefined special tokens converted to byte values) to the game. You can use this to implement support for a [[Manual:Supported_Protocols#Adding_support_for_a_telnet_protocol|new telnet protocol]], [http://forums.mudlet.org/viewtopic.php?f=5&t=2272 simultronics] [http://forums.mudlet.org/viewtopic.php?f=5&t=2213#p9810 login] etc.
 ;Example
 <syntaxhighlight lang="lua">
-TN_IAC = 255
+-- Tell the Server that we are now willing and able to process  to process Ask the Server to a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
-TN_WILL = 251
+-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
-TN_DO = 253
+-- comments up top should introduce / explain what it does
-MSDP_VAL = 1
+local something = function(exampleValue)
-MSDP_VAR = 2
+if something then
-sendSocket( string.char( TN_IAC, TN_DO, TN_MSDP ) ) -- sends IAC DO MSDP
+-- maybe another example for the optional second case
---sends: IAC  SB MSDP MSDP_VAR "LIST" MSDP_VAL "COMMANDS" IAC SE
+-- lastly, include an example with error handling to give an idea of good practice
-local msg = string.char( TN_IAC, TN_SB, TN_MSDP, MSDP_VAR ) .. " LIST " ..string.char( MSDP_VAL ) .. " COMMANDS " .. string.char( TN_IAC, TN_SE )
+local ok, err = function()
-sendSocket( msg )
+if not ok then
 </syntaxhighlight>
-{{Note}} Remember that should it be necessary to send the byte value of 255 as a ''data'' byte and not as the Telnet '''IAC''' value it is required to repeat it for Telnet to ignore it and not treat it as the latter.
+; Additional development notes
 ==setIrcChannels==

← Older revision		Revision as of 09:08, 24 December 2024
Line 368:		Line 368:

	To see the list of options that Aardwolf supports go to: [http://www.aardwolf.com/blog/2008/07/10/telnet-negotiation-control-mud-client-interaction/ Using Telnet negotiation to control MUD client interaction].		To see the list of options that Aardwolf supports go to: [http://www.aardwolf.com/blog/2008/07/10/telnet-negotiation-control-mud-client-interaction/ Using Telnet negotiation to control MUD client interaction].
		+
		+	==sendSocket==
		+	;sendSocket(data)
		+
		+	:Sends given binary data as-is to the game. You can use this to implement support for a [[Manual:Supported_Protocols#Adding_support_for_a_telnet_protocol\|new telnet protocol]], [http://forums.mudlet.org/viewtopic.php?f=5&t=2272 simultronics] [http://forums.mudlet.org/viewtopic.php?f=5&t=2213#p9810 login] or etcetera.
		+
		+	;Example
		+	<syntaxhighlight lang="lua">
		+	TN_IAC = 255
		+	TN_WILL = 251
		+	TN_DO = 253
		+	TN_SB = 250
		+	TN_SE = 240
		+	TN_MSDP = 69
		+
		+	MSDP_VAL = 1
		+	MSDP_VAR = 2
		+
		+	sendSocket( string.char( TN_IAC, TN_DO, TN_MSDP ) ) -- sends IAC DO MSDP
		+
		+	--sends: IAC SB MSDP MSDP_VAR "LIST" MSDP_VAL "COMMANDS" IAC SE
		+	local msg = string.char( TN_IAC, TN_SB, TN_MSDP, MSDP_VAR ) .. " LIST " ..string.char( MSDP_VAL ) .. " COMMANDS " .. string.char( TN_IAC, TN_SE )
		+	sendSocket( msg )
		+	</syntaxhighlight>
		+
		+	{{Note}} Remember that should it be necessary to send the byte value of 255 as a ''data'' byte and not as the Telnet '''IAC''' value it is required to repeat it for Telnet to ignore it and not treat it as the latter.

	==setIrcChannels==		==setIrcChannels==