OODebugTCPConsoleProtocol.h File Reference

#include <CoreFoundation/CoreFoundation.h>

Include dependency graph for OODebugTCPConsoleProtocol.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	OOALSTR(x)   CFSTR(x)
#define	kOOTCPPacket_RequestConnection   OOALSTR("Request Connection")
#define	kOOTCPPacket_ApproveConnection   OOALSTR("Approve Connection")
#define	kOOTCPPacket_RejectConnection   OOALSTR("Reject Connection")
#define	kOOTCPPacket_CloseConnection   OOALSTR("Close Connection")
#define	kOOTCPPacket_ConsoleOutput   OOALSTR("Console Output")
#define	kOOTCPPacket_ClearConsole   OOALSTR("Clear Console")
#define	kOOTCPPacket_ShowConsole   OOALSTR("Show Console")
#define	kOOTCPPacket_NoteConfiguration   OOALSTR("Note Configuration")
#define	kOOTCPPacket_NoteConfigurationChange   OOALSTR("Note Configuration Change")
#define	kOOTCPPacket_PerformCommand   OOALSTR("Perform Command")
#define	kOOTCPPacket_RequestConfigurationValue   OOALSTR("Request Configuration Value")
#define	kOOTCPPacket_Ping   OOALSTR("Ping")
#define	kOOTCPPacket_Pong   OOALSTR("Pong")
#define	kOOTCPPacketType   OOALSTR("packet type")
#define	kOOTCPProtocolVersion   OOALSTR("protocol version")
#define	kOOTCPOoliteVersion   OOALSTR("Oolite version")
#define	kOOTCPMessage   OOALSTR("message")
#define	kOOTCPConsoleIdentity   OOALSTR("console identity")
#define	kOOTCPColorKey   OOALSTR("color key")
#define	kOOTCPEmphasisRanges   OOALSTR("emphasis ranges")
#define	kOOTCPConfiguration   OOALSTR("configuration")
#define	kOOTCPRemovedConfigurationKeys   OOALSTR("removed configuration keys")
#define	kOOTCPConfigurationKey   OOALSTR("configuration key")
#define	OOTCP_ENCODE_VERSION(f, mj, mi)
#define	OOTCP_VERSION_FORMAT(v)   (((v) & kOOTCPProtocolVersionFormatMask) >> 16)
#define	OOTCP_VERSION_MAJOR(v)   (((v) & kOOTCPProtocolVersionMajorMask) >> 8)
#define	OOTCP_VERSION_MINOR(v)   ((v) & kOOTCPProtocolVersionMinorMask)

Enumerations
enum	{ kOOTCPConsolePort = 0x002173 }
enum	{   kOOTCPProtocolVersionFormatMask = 0x00FF0000 , kOOTCPProtocolVersionMajorMask = 0x0000FF00 , kOOTCPProtocolVersionMinorMask = 0x000000FF , kOOTCPProtocolVersionPListFormat = 1 ,   kOOTCPProtocolVersion_1_1_0 = OOTCP_ENCODE_VERSION(kOOTCPProtocolVersionPListFormat, 1, 0) }

Macro Definition Documentation

kOOTCPColorKey

#define kOOTCPColorKey   OOALSTR("color key")

Definition at line 274 of file OODebugTCPConsoleProtocol.h.

kOOTCPConfiguration

#define kOOTCPConfiguration   OOALSTR("configuration")

Definition at line 288 of file OODebugTCPConsoleProtocol.h.

kOOTCPConfigurationKey

#define kOOTCPConfigurationKey   OOALSTR("configuration key")

Definition at line 300 of file OODebugTCPConsoleProtocol.h.

kOOTCPConsoleIdentity

#define kOOTCPConsoleIdentity   OOALSTR("console identity")

Definition at line 255 of file OODebugTCPConsoleProtocol.h.

kOOTCPEmphasisRanges

#define kOOTCPEmphasisRanges   OOALSTR("emphasis ranges")

Definition at line 281 of file OODebugTCPConsoleProtocol.h.

kOOTCPMessage

#define kOOTCPMessage   OOALSTR("message")

Definition at line 250 of file OODebugTCPConsoleProtocol.h.

kOOTCPOoliteVersion

#define kOOTCPOoliteVersion   OOALSTR("Oolite version")

Definition at line 245 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_ApproveConnection

#define kOOTCPPacket_ApproveConnection   OOALSTR("Approve Connection")

Definition at line 95 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_ClearConsole

#define kOOTCPPacket_ClearConsole   OOALSTR("Clear Console")

Definition at line 137 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_CloseConnection

#define kOOTCPPacket_CloseConnection   OOALSTR("Close Connection")

Definition at line 119 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_ConsoleOutput

#define kOOTCPPacket_ConsoleOutput   OOALSTR("Console Output")

Definition at line 131 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_NoteConfiguration

#define kOOTCPPacket_NoteConfiguration   OOALSTR("Note Configuration")

Definition at line 154 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_NoteConfigurationChange

#define kOOTCPPacket_NoteConfigurationChange   OOALSTR("Note Configuration Change")

Definition at line 173 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_PerformCommand

#define kOOTCPPacket_PerformCommand   OOALSTR("Perform Command")

Definition at line 182 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_Ping

#define kOOTCPPacket_Ping   OOALSTR("Ping")

Definition at line 207 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_Pong

#define kOOTCPPacket_Pong   OOALSTR("Pong")

Definition at line 218 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_RejectConnection

#define kOOTCPPacket_RejectConnection   OOALSTR("Reject Connection")

Definition at line 108 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_RequestConfigurationValue

#define kOOTCPPacket_RequestConfigurationValue   OOALSTR("Request Configuration Value")

Definition at line 195 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_RequestConnection

#define kOOTCPPacket_RequestConnection   OOALSTR("Request Connection")

Definition at line 85 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacket_ShowConsole

#define kOOTCPPacket_ShowConsole   OOALSTR("Show Console")

Definition at line 144 of file OODebugTCPConsoleProtocol.h.

kOOTCPPacketType

#define kOOTCPPacketType   OOALSTR("packet type")

Definition at line 229 of file OODebugTCPConsoleProtocol.h.

Referenced by PacketReady().

kOOTCPProtocolVersion

#define kOOTCPProtocolVersion   OOALSTR("protocol version")

Definition at line 237 of file OODebugTCPConsoleProtocol.h.

kOOTCPRemovedConfigurationKeys

#define kOOTCPRemovedConfigurationKeys   OOALSTR("removed configuration keys")

Definition at line 294 of file OODebugTCPConsoleProtocol.h.

OOALSTR

#define OOALSTR

(

x

)

CFSTR(x)

Definition at line 39 of file OODebugTCPConsoleProtocol.h.

Referenced by OOTCPStreamDecoderReceiveBytes(), and PacketReady().

OOTCP_ENCODE_VERSION

#define OOTCP_ENCODE_VERSION	(		f,
			mj,
			mi )

Value:

        ((((f) << 16) & kOOTCPProtocolVersionFormatMask) | \
        (((f) << 8) & kOOTCPProtocolVersionMajorMask) | \
        ((mi) & kOOTCPProtocolVersionMinorMask))

Definition at line 312 of file OODebugTCPConsoleProtocol.h.

#define OOTCP_ENCODE_VERSION(f, mj, mi) \
        ((((f) << 16) & kOOTCPProtocolVersionFormatMask) | \
        (((f) << 8) & kOOTCPProtocolVersionMajorMask) | \
        ((mi) & kOOTCPProtocolVersionMinorMask))

OOTCP_VERSION_FORMAT

#define OOTCP_VERSION_FORMAT

(

v

)

(((v) & kOOTCPProtocolVersionFormatMask) >> 16)

Definition at line 317 of file OODebugTCPConsoleProtocol.h.

OOTCP_VERSION_MAJOR

#define OOTCP_VERSION_MAJOR

(

v

)

(((v) & kOOTCPProtocolVersionMajorMask) >> 8)

Definition at line 318 of file OODebugTCPConsoleProtocol.h.

OOTCP_VERSION_MINOR

#define OOTCP_VERSION_MINOR

(

v

)

((v) & kOOTCPProtocolVersionMinorMask)

Definition at line 319 of file OODebugTCPConsoleProtocol.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kOOTCPConsolePort

Definition at line 44 of file OODebugTCPConsoleProtocol.h.

{
    kOOTCPConsolePort           = 0x002173  /* = 8563 */
};

anonymous enum

anonymous enum

Enumerator
kOOTCPProtocolVersionFormatMask
kOOTCPProtocolVersionMajorMask
kOOTCPProtocolVersionMinorMask
kOOTCPProtocolVersionPListFormat
kOOTCPProtocolVersion_1_1_0

Definition at line 321 of file OODebugTCPConsoleProtocol.h.

{
    kOOTCPProtocolVersionFormatMask     = 0x00FF0000,
    kOOTCPProtocolVersionMajorMask      = 0x0000FF00,
    kOOTCPProtocolVersionMinorMask      = 0x000000FF,
    
    kOOTCPProtocolVersionPListFormat    = 1,
    
    // 1:1.0, first version.
    kOOTCPProtocolVersion_1_1_0         = OOTCP_ENCODE_VERSION(kOOTCPProtocolVersionPListFormat, 1, 0)
};