minetest/doc/protocol.txt

111 lines
3.4 KiB
Plaintext
Raw Normal View History

2013-02-24 18:40:43 +01:00
Minetest protocol (incomplete, early draft):
2011-06-18 19:16:11 +02:00
Updated 2011-06-18
A custom protocol over UDP.
2011-06-18 19:27:17 +02:00
Integers are big endian.
Refer to connection.{h,cpp} for further reference.
2011-06-18 19:16:11 +02:00
Initialization:
- A dummy reliable packet with peer_id=PEER_ID_INEXISTENT=0 is sent to the server:
- Actually this can be sent without the reliable packet header, too, i guess,
but the sequence number in the header allows the sender to re-send the
packet without accidentally getting a double initialization.
- Packet content:
# Basic header
u32 protocol_id = PROTOCOL_ID = 0x4f457403
u16 sender_peer_id = PEER_ID_INEXISTENT = 0
u8 channel = 0
# Reliable packet header
u8 type = TYPE_RELIABLE = 3
2011-06-18 19:21:25 +02:00
u16 seqnum = SEQNUM_INITIAL = 65500
2011-06-18 19:16:11 +02:00
# Original packet header
u8 type = TYPE_ORIGINAL = 1
# And no actual payload.
- Server responds with something like this:
- Packet content:
# Basic header
u32 protocol_id = PROTOCOL_ID = 0x4f457403
u16 sender_peer_id = PEER_ID_INEXISTENT = 0
u8 channel = 0
2011-06-18 19:18:13 +02:00
# Reliable packet header
u8 type = TYPE_RELIABLE = 3
2011-06-18 19:21:25 +02:00
u16 seqnum = SEQNUM_INITIAL = 65500
2011-06-18 19:16:11 +02:00
# Control packet header
u8 type = TYPE_CONTROL = 0
u8 controltype = CONTROLTYPE_SET_PEER_ID = 1
u16 peer_id_new = assigned peer id to client (other than 0 or 1)
2011-06-18 19:18:13 +02:00
- Then the connection can be disconnected by sending:
- Packet content:
# Basic header
u32 protocol_id = PROTOCOL_ID = 0x4f457403
u16 sender_peer_id = whatever was gotten in CONTROLTYPE_SET_PEER_ID
u8 channel = 0
# Control packet header
u8 type = TYPE_CONTROL = 0
u8 controltype = CONTROLTYPE_DISCO = 3
2011-06-18 19:16:11 +02:00
2011-06-18 20:36:31 +02:00
- Here's a quick untested connect-disconnect done in PHP:
# host: ip of server (use gethostbyname(hostname) to get from a dns name)
# port: port of server
function check_if_minetestserver_up($host, $port)
{
2011-06-18 20:36:31 +02:00
$socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
$timeout = array("sec" => 1, "usec" => 0);
socket_set_option($socket, SOL_SOCKET, SO_RCVTIMEO, $timeout);
$buf = "\x4f\x45\x74\x03\x00\x00\x00\x03\xff\xdc\x01";
socket_sendto($socket, $buf, strlen($buf), 0, $host, $port);
$buf = socket_read($socket, 1000);
if($buf != "")
{
# We got a reply! read the peer id from it.
$peer_id = substr($buf, 9, 2);
2011-06-18 20:36:31 +02:00
# Disconnect
$buf = "\x4f\x45\x74\x03".$peer_id."\x00\x00\x03";
2011-06-18 20:36:31 +02:00
socket_sendto($socket, $buf, strlen($buf), 0, $host, $port);
socket_close($socket);
2011-06-18 20:36:31 +02:00
return true;
}
return false;
}
2011-06-18 20:36:31 +02:00
2013-02-28 20:15:34 +01:00
- Here's a Python script for checking if a minetest server is up, confirmed working
#!/usr/bin/env python3
2013-02-28 20:15:34 +01:00
import sys, time, socket
2013-02-28 20:15:34 +01:00
address = ""
port = 30000
if len(sys.argv) <= 1:
print("Usage: %s <address>" % sys.argv[0])
exit()
if ":" in sys.argv[1]:
address = sys.argv[1].split(":")[0]
2013-02-28 20:15:34 +01:00
try:
port = int(sys.argv[1].split(":")[1])
2013-02-28 20:15:34 +01:00
except ValueError:
print("Please specify a valid port")
exit()
else:
address = sys.argv[1]
try:
start = time.time()
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.settimeout(2.0)
buf = b"\x4f\x45\x74\x03\x00\x00\x00\x01"
2013-02-28 20:15:34 +01:00
sock.sendto(buf, (address, port))
data, addr = sock.recvfrom(1000)
if data:
peer_id = data[12:14]
buf = b"\x4f\x45\x74\x03" + peer_id + b"\x00\x00\x03"
2013-02-28 20:15:34 +01:00
sock.sendto(buf, (address, port))
sock.close()
end = time.time()
print("%s is up (%0.5fms)" % (sys.argv[1], end - start))
2013-02-28 20:15:34 +01:00
else:
print("%s seems to be down " % sys.argv[1])
except Exception as err:
print("%s seems to be down (%s) " % (sys.argv[1], str(err)))