OpenTTD Source: src/network/core/tcp_content_type.h File Reference

OpenTTD Source 15.0-RC2

Data Structures | Typedefs | Enumerations | Variables
tcp_content_type.h File Reference

Basic types related to the content on the content server. More...

`#include "../../3rdparty/md5/md5.h"`
`#include "../../string_type.h"`
`#include "../../textfile_type.h"`

Go to the source code of this file.

## Data Structures
struct | ContentInfo
| Container for all important information about a piece of content. More...

## Typedefs
using | ContentTypes = EnumBitSet< ContentType, uint16_t, CONTENT_TYPE_END >
using | ContentID = uint32_t
| Unique identifier for the content.

## Enumerations
enum | ContentType : uint8_t { CONTENT_TYPE_BEGIN = 1 , CONTENT_TYPE_BASE_GRAPHICS = 1 , CONTENT_TYPE_NEWGRF = 2 , CONTENT_TYPE_AI = 3 , CONTENT_TYPE_AI_LIBRARY = 4 , CONTENT_TYPE_SCENARIO = 5 , CONTENT_TYPE_HEIGHTMAP = 6 , CONTENT_TYPE_BASE_SOUNDS = 7 , CONTENT_TYPE_BASE_MUSIC = 8 , CONTENT_TYPE_GAME = 9 , CONTENT_TYPE_GAME_LIBRARY = 10 , CONTENT_TYPE_END , INVALID_CONTENT_TYPE = 0xFF }
| The values in the enum are important; they are used as database 'keys'. More...
enum | PacketContentType : uint8_t { PACKET_CONTENT_CLIENT_INFO_LIST , PACKET_CONTENT_CLIENT_INFO_ID , PACKET_CONTENT_CLIENT_INFO_EXTID , PACKET_CONTENT_CLIENT_INFO_EXTID_MD5 , PACKET_CONTENT_SERVER_INFO , PACKET_CONTENT_CLIENT_CONTENT , PACKET_CONTENT_SERVER_CONTENT , PACKET_CONTENT_END }
| Enum with all types of TCP content packets. More...

## Variables
static constexpr ContentID | INVALID_CONTENT_ID = UINT32_MAX
| Sentinel for invalid content.

## Detailed Description

Basic types related to the content on the content server.

Definition in file tcp_content_type.h.

## Typedef Documentation

## ◆ ContentID

using ContentID = uint32_t

Unique identifier for the content.

Definition at line 51 of file tcp_content_type.h.

## ◆ ContentTypes

using ContentTypes = EnumBitSet<ContentType, uint16_t, CONTENT_TYPE_END>

Definition at line 36 of file tcp_content_type.h.

## Enumeration Type Documentation

## ◆ ContentType

enum ContentType : uint8_t

The values in the enum are important; they are used as database 'keys'.

Enumerator
CONTENT_TYPE_BEGIN | Helper to mark the begin of the types.
CONTENT_TYPE_BASE_GRAPHICS | The content consists of base graphics.
CONTENT_TYPE_NEWGRF | The content consists of a NewGRF.
CONTENT_TYPE_AI | The content consists of an AI.
CONTENT_TYPE_AI_LIBRARY | The content consists of an AI library.
CONTENT_TYPE_SCENARIO | The content consists of a scenario.
CONTENT_TYPE_HEIGHTMAP | The content consists of a heightmap.
CONTENT_TYPE_BASE_SOUNDS | The content consists of base sounds.
CONTENT_TYPE_BASE_MUSIC | The content consists of base music.
CONTENT_TYPE_GAME | The content consists of a game script.
CONTENT_TYPE_GAME_LIBRARY | The content consists of a GS library.
CONTENT_TYPE_END | Helper to mark the end of the types.
INVALID_CONTENT_TYPE | Invalid/uninitialized content.

Definition at line 21 of file tcp_content_type.h.

## ◆ PacketContentType

enum PacketContentType : uint8_t

Enum with all types of TCP content packets.

The order MUST not be changed

Enumerator
PACKET_CONTENT_CLIENT_INFO_LIST | Queries the content server for a list of info of a given content type.
PACKET_CONTENT_CLIENT_INFO_ID | Queries the content server for information about a list of internal IDs.
PACKET_CONTENT_CLIENT_INFO_EXTID | Queries the content server for information about a list of external IDs.
PACKET_CONTENT_CLIENT_INFO_EXTID_MD5 | Queries the content server for information about a list of external IDs and MD5.
PACKET_CONTENT_SERVER_INFO | Reply of content server with information about content.
PACKET_CONTENT_CLIENT_CONTENT | Request a content file given an internal ID.
PACKET_CONTENT_SERVER_CONTENT | Reply with the content of the given ID.
PACKET_CONTENT_END | Must ALWAYS be on the end of this list!! (period)

Definition at line 39 of file tcp_content_type.h.

## Variable Documentation

## ◆ INVALID_CONTENT_ID

constexpr ContentID INVALID_CONTENT_ID = UINT32_MAX
| staticconstexpr

Sentinel for invalid content.

Definition at line 53 of file tcp_content_type.h.