lib/gamnit/network/common.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 # Services common to the `client` and `server` modules
  16 module common
  17
  18 import socket
  19 import binary::serialization
  20
  21 # Unique name of the application to use in the handshake
  22 #
  23 # This name must be the same between client/server and
  24 # it should not be used by other programs that may interfere.
  25 #
  26 # Both client and server refuse connections with a different name.
  27 fun handshake_app_name: String do return program_name
  28
  29 # Version of the communication protocol to use in the handshake
  30 #
  31 # Its value should change with the communication protocol in such a way
  32 # that different versions indicates incompatible protocols.
  33 #
  34 # Both client and server refuse connections with a different version.
  35 fun handshake_app_version: String do return "0.0"
  36
  37 # Server port listening for discovery requests
  38 #
  39 # This name must be the same between client/server.
  40 fun discovery_port: Int do return 18722
  41
  42 # First word in discovery requests
  43 private fun discovery_request_message: String do return "gamnit::network?"
  44
  45 # First word in discovery responses
  46 private fun discovery_response_message: String do return "gamnit::network!"