OpenTTD Source: TCPListenHandler< Tsocket, Tfull_packet, Tban_packet > Class Template Reference

OpenTTD Source 14.1

Static Public Member Functions | Static Private Attributes
TCPListenHandler< Tsocket, Tfull_packet, Tban_packet > Class Template Reference

Template for TCP listeners. More...

`#include <tcp_listen.h>`

## Static Public Member Functions
static bool | ValidateClient (SOCKET s, NetworkAddress &address)
static void | AcceptClient (SOCKET ls)
| Accepts clients from the sockets. More...
static bool | Receive ()
| Handle the receiving of packets. More...
static bool | Listen (uint16_t port)
| Listen on a particular port. More...
static void | CloseListeners ()
| Close the sockets we're listening on.

## Static Private Attributes
static SocketList | sockets
| List of sockets we listen on.

## Detailed Description

### template<class Tsocket, PacketType Tfull_packet, PacketType Tban_packet>
class TCPListenHandler< Tsocket, Tfull_packet, Tban_packet >

Template for TCP listeners.

Parameters

  Tsocket | The class we create sockets for.
  Tfull_packet | The packet type to return when we don't allow more sockets.
  Tban_packet | The packet type to return when the client is banned.

Definition at line 28 of file tcp_listen.h.

## Member Function Documentation

## ◆ AcceptClient()

template<class Tsocket , PacketType Tfull_packet, PacketType Tban_packet>

static void TCPListenHandler< Tsocket, Tfull_packet, Tban_packet >::AcceptClient | ( | SOCKET | ls | ) |
| inlinestatic

Accepts clients from the sockets.

Parameters

  ls | Socket to accept clients from.

Definition at line 73 of file tcp_listen.h.

Referenced by TCPListenHandler< ServerNetworkGameSocketHandler, PACKET_SERVER_FULL, PACKET_SERVER_BANNED >::Receive().

## ◆ Listen()

template<class Tsocket , PacketType Tfull_packet, PacketType Tban_packet>

static bool TCPListenHandler< Tsocket, Tfull_packet, Tban_packet >::Listen | ( | uint16_t | port | ) |
| inlinestatic

Listen on a particular port.

Parameters

  port | The port to listen on.

Returns
  true if listening succeeded.

Definition at line 143 of file tcp_listen.h.

## ◆ Receive()

template<class Tsocket , PacketType Tfull_packet, PacketType Tban_packet>

static bool TCPListenHandler< Tsocket, Tfull_packet, Tban_packet >::Receive | ( |  | ) |
| inlinestatic

Handle the receiving of packets.

Returns
  true if everything went okay.

Definition at line 101 of file tcp_listen.h.

The documentation for this class was generated from the following file:

- src/network/core/tcp_listen.h