Services common to the client and server modules

Redefined classes

redef class Sys

gamnit :: common $ Sys

The main class of the program.

All class definitions

redef class Sys

gamnit :: common $ Sys

The main class of the program.
package_diagram gamnit::common common socket socket gamnit::common->socket msgpack msgpack gamnit::common->msgpack core core socket->core msgpack->core serialization serialization msgpack->serialization json json msgpack->json binary binary msgpack->binary ...core ... ...core->core ...serialization ... ...serialization->serialization ...json ... ...json->json ...binary ... ...binary->binary gamnit::client client gamnit::client->gamnit::common gamnit::server server gamnit::server->gamnit::common gamnit::network network gamnit::network->gamnit::client gamnit::network->gamnit::server gamnit::network... ... gamnit::network...->gamnit::network

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.
module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters
module array

core :: array

This module introduces the standard array structure.
module binary

binary :: binary

Read and write binary data with any Reader and Writer
module bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
module caching

serialization :: caching

Services for caching serialization engines
module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.
module codec_base

core :: codec_base

Base for codecs to use with streams
module codecs

core :: codecs

Group module for all codec-related manipulations
module collection

core :: collection

This module define several collection classes.
module core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
module engine_tools

serialization :: engine_tools

Advanced services for serialization engines
module environ

core :: environ

Access to the environment variables of the process
module error

core :: error

Standard error-management infrastructure.
module error

json :: error

Intro JsonParseError which is exposed by all JSON reading APIs
module exec

core :: exec

Invocation and management of operating system sub-processes.
module ext

msgpack :: ext

Application specific MessagePack extension MsgPackExt
module file

core :: file

File manipulations (create, read, write, etc.)
module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision
module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints
module flat

core :: flat

All the array-based text representations
module gc

core :: gc

Access to the Nit internal garbage collection mechanism
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module json

json :: json

Read and write JSON formatted text using the standard serialization services
module kernel

core :: kernel

Most basic classes and methods.
module list

core :: list

This module handle double linked lists
module math

core :: math

Mathematical operations
module meta

meta :: meta

Simple user-defined meta-level to manipulate types of instances as object.
module native

core :: native

Native structures for text and bytes
module numeric

core :: numeric

Advanced services for Numeric types
module parser_base

parser_base :: parser_base

Simple base for hand-made parsers of all kinds
module poset

poset :: poset

Pre order sets and partial order set (ie hierarchies)
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module re

core :: re

Regular expression support for all services based on Pattern
module read

msgpack :: read

Low-level read MessagePack format from Reader streams
module ropes

core :: ropes

Tree-based representation of a String.
module safe

serialization :: safe

Services for safer deserialization engines
module serialization

serialization :: serialization

General serialization services
module serialization_common

msgpack :: serialization_common

Serialization services for serialization_write and serialization_read
module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats
module serialization_read

json :: serialization_read

Services to read JSON: deserialize_json and JsonDeserializer
module serialization_read

msgpack :: serialization_read

Deserialize full Nit objects from MessagePack format
module serialization_write

msgpack :: serialization_write

Serialize full Nit objects to MessagePack format
module serialization_write

json :: serialization_write

Services to write Nit objects to JSON strings: serialize_to_json and JsonSerializer
module socket_c

socket :: socket_c

Low-level socket functionalities
module sorter

core :: sorter

This module contains classes used to compare things and sorts arrays.
module static

json :: static

Static interface to read Nit objects from JSON strings
module stream

core :: stream

Input and output streams of characters
module text

core :: text

All the classes and methods related to the manipulation of text entities
module time

core :: time

Management of time and dates
module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure
module utf8

core :: utf8

Codec for UTF-8 I/O
module write

msgpack :: write

Low-level write in MessagePack format to Writer streams

Parents

module msgpack

msgpack :: msgpack

MessagePack, an efficient binary serialization format
module socket

socket :: socket

Socket services

Children

module client

gamnit :: client

Client-side network services for games and such
module server

gamnit :: server

Server-side network services for games and such

Descendants

module a_star-m

a_star-m

module network

gamnit :: network

Easy client/server logic for games and simple distributed applications
# Services common to the `client` and `server` modules
module common

import socket
import msgpack

# Unique name of the application to use in the handshake
#
# This name must be the same between client/server and
# it should not be used by other programs that may interfere.
# Both client and server refuse connections with a different name.
#
# This value must not contain spaces.
fun handshake_app_name: String do return program_name

# Version of the communication protocol to use in the handshake
#
# Its value should change with the communication protocol in such a way
# that different versions indicates incompatible protocols.
#
# Both client and server refuse connections with a different version.
#
# This value must not contain spaces.
fun handshake_app_version: String do return "0.0"

# Server port listening for discovery requests
#
# This name must be the same between client/server.
fun discovery_port: Int do return 18722

# First word in discovery requests
private fun discovery_request_message: String do return "gamnit::network?"

# First word in discovery responses
private fun discovery_response_message: String do return "gamnit::network!"
lib/gamnit/network/common.nit:15,1--49,75