Difference between revisions of "Network subsystem"

From OpenKore Wiki
Jump to navigation Jump to search
(need write)
 
Line 1: Line 1:
Source: http://web.archive.org/web/20080529154542/http://www.openkore.com/wiki/index.php/Network_subsystem
+
__TOC__
 +
 
 +
The OpenKore network subsystem roughly consists of the following classes:
 +
 
 +
=== The ''Network'' class ===
 +
 
 +
This is the connection manager. It manages the TCP/IP socket connection with the server, and handles things like connection, disconnection, sending data to the server, receiving data from the server, etc. But it doesn't do much else.
 +
 
 +
Schematically, it looks like this:
 +
 
 +
[[File:network-subsystem.jpg]]
 +
 
 +
Upon connection to the server, it creates two objects:
 +
 
 +
* A message parser object, which is of class ''Network::Receive::ServerTypeX''. Whenever a message is received from the server, that message is passed to the message parser.
 +
* A message sender object (not seen in the above diagram), which is of class ''Network::Send::ServerTypeX''. This is used for sending messages to the server.
 +
 
 +
There are several implementations of ''Network'' class: ''Network::DirectConnection'', ''Network::[[XKore]]'' and ''Network::XKoreProxy''.
 +
 
 +
=== The ''Network::MessageTokenizer'' class ===
 +
 
 +
This is a [[wikipedia:Lexical analysis#Tokenizer|tokenizer]] class. It extracts discrete server or client messages from a byte stream passed by the connection manager. But it doesn't do much else.
 +
 
 +
=== The ''Network::PacketParser'' class ===
 +
 
 +
This is a base message parser class. It parses messages passed by the connection manager into hashes with message data, as well as does reverse operation - generates messages from hashes with message data. But it doesn't do much else.
 +
 
 +
Afterwards, parsed messages are handled by built-in handlers in following classes and, with [[hook]]s, by plugins or other modules.
 +
 
 +
Additionally, there is API for [[mangle|modifying or dropping]] messages to alter any further processing.
 +
 
 +
=== The ''Network::Receive'', ''Network::Send'' and ''Network::ClientReceive'' classes ===
 +
 
 +
There classes are descendants of ''Network::PacketParser'' class.
 +
 
 +
''Network::Receive'' and ''Network::Send'' are parser helper classes. They contain parser helpers which serve as a workaround in the absense of the capable parser subsystem.
 +
 
 +
''Network::Receive'' and ''Network::ClientReceive'' are message handling classes. They contain built-in handlers for messages coming from the server (''Network::Receive'') or from the client (''Network::ClientReceive''), which store information from network messages to be used later in other modules (like the AI).
 +
 
 +
''Network::Send'' is the message sender class. It encapsulates network messages into simple, easy-to-use functions to be used outside of network subsystem.
 +
 
 +
Any descendant ''ServerType'' class may customize message handlers and parser helpers, but they should refrain from that other than for servertype-specific features and debugging.
 +
 
 +
=== The ''Network::Receive::ServerTypeX'' and ''Network::Send::ServerTypeX'' class ===
 +
 
 +
These are [[serverType]] description classes. They describe network message identifiers and structures for different servers. But they shouldn't do much else.
 +
 
 +
Note that none of these classes, from the connection manager to the serverType descriptions, should contain any AI code.
 +
 
 +
== Handling multiple server types (message parser part) ==
 +
 
 +
=== Implementation details ===
 +
 
 +
==== Example 1: adding a new message handler ====
 +
 
 +
==== Example 2: handling a different server type ====
 +
 
 +
== Handling multiple server types (message sender part) ==
 +
 
 +
== Using the message sender ==
 +
 
 +
=== Compatibility notes ===
 +
 
 +
== Hooks ==
 +
 
 +
=== "packet_pre/$HANDLER_NAME" ===
 +
 
 +
=== "packet/$HANDLER_NAME" ===
 +
 
 +
== Appendix A: introduction to the Ragnarok Online protocol ==
 +
 
 +
== Appendix B: recvpackets.txt and handling message lengths ==
 +
 
 +
== Appendix C: obfuscation of outgoing messages ==
 +
 
 +
=== Padded packets ===
 +
 
 +
=== Encrypted message IDs ===
 +
 
 +
== Original article ==
 +
 
 +
http://web.archive.org/web/20090305035837/http://www.openkore.com/wiki/index.php/Network_subsystem

Revision as of 16:35, 22 November 2012

The OpenKore network subsystem roughly consists of the following classes:

The Network class

This is the connection manager. It manages the TCP/IP socket connection with the server, and handles things like connection, disconnection, sending data to the server, receiving data from the server, etc. But it doesn't do much else.

Schematically, it looks like this:

File:Network-subsystem.jpg

Upon connection to the server, it creates two objects:

  • A message parser object, which is of class Network::Receive::ServerTypeX. Whenever a message is received from the server, that message is passed to the message parser.
  • A message sender object (not seen in the above diagram), which is of class Network::Send::ServerTypeX. This is used for sending messages to the server.

There are several implementations of Network class: Network::DirectConnection, Network::XKore and Network::XKoreProxy.

The Network::MessageTokenizer class

This is a tokenizer class. It extracts discrete server or client messages from a byte stream passed by the connection manager. But it doesn't do much else.

The Network::PacketParser class

This is a base message parser class. It parses messages passed by the connection manager into hashes with message data, as well as does reverse operation - generates messages from hashes with message data. But it doesn't do much else.

Afterwards, parsed messages are handled by built-in handlers in following classes and, with hooks, by plugins or other modules.

Additionally, there is API for modifying or dropping messages to alter any further processing.

The Network::Receive, Network::Send and Network::ClientReceive classes

There classes are descendants of Network::PacketParser class.

Network::Receive and Network::Send are parser helper classes. They contain parser helpers which serve as a workaround in the absense of the capable parser subsystem.

Network::Receive and Network::ClientReceive are message handling classes. They contain built-in handlers for messages coming from the server (Network::Receive) or from the client (Network::ClientReceive), which store information from network messages to be used later in other modules (like the AI).

Network::Send is the message sender class. It encapsulates network messages into simple, easy-to-use functions to be used outside of network subsystem.

Any descendant ServerType class may customize message handlers and parser helpers, but they should refrain from that other than for servertype-specific features and debugging.

The Network::Receive::ServerTypeX and Network::Send::ServerTypeX class

These are serverType description classes. They describe network message identifiers and structures for different servers. But they shouldn't do much else.

Note that none of these classes, from the connection manager to the serverType descriptions, should contain any AI code.

Handling multiple server types (message parser part)

Implementation details

Example 1: adding a new message handler

Example 2: handling a different server type

Handling multiple server types (message sender part)

Using the message sender

Compatibility notes

Hooks

"packet_pre/$HANDLER_NAME"

"packet/$HANDLER_NAME"

Appendix A: introduction to the Ragnarok Online protocol

Appendix B: recvpackets.txt and handling message lengths

Appendix C: obfuscation of outgoing messages

Padded packets

Encrypted message IDs

Original article

http://web.archive.org/web/20090305035837/http://www.openkore.com/wiki/index.php/Network_subsystem