cctalk-pkts.h File Reference

---

Detailed Description

This is the header file for cctalk socket communication between client and server.

Each structure in this file defines a packet that is sent between the client and the server for cctalk communication. A packet is made up of a header and then a packet body with a checksum on the end. Packet types are listed in the enum eCCTALK_PACKET_TYPES

Author:

Rod Boyce

Date:

02/11/04

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

Go to the source code of this file.

Data Structures
struct	tsCCTALK_SOCK_PKT_HDR
	This is the header for any packet that traverses the cctalk socket. More...
struct	tsCCTALK_PKT_ERROR_MSG
	The error messages returned from the cctalk driver to the client. More...
struct	tsCCTALK_OPERATION_PKT
	This is the definition of a cctalk operation packet. More...
struct	tsCCT_PKT_CHANNEL_CMD
	The definition of a cctalk channel command packet. More...
struct	tsCCTALK_OP_REPLY_PKT
	This is the definition of a cctalk operation reply packet. More...
Typedefs
typedef unsigned short	tCHECKSUM
	This is the checksum typedef at the moment it is a 16-bit value.
Enumerations
enum	eCCTALK_PACKET_CONSTANTS { eCCT_PKT_VERSION = 1, eCCT_PKT_IDENTIFIER = 0x20041021 }
	Global constants used by the cctalk client server packet code. More...
enum	eCCTALK_PACKET_TYPES {   eCCT_PKT_NOT_USED = 0, eCCT_PKT_ERROR_MSG, eCCT_PKT_OPERATION, eCCT_PKT_GET_OPER,   eCCT_PKT_OP_REPLY, eCCT_PKT_OPEN_CHANNEL, eCCT_PKT_CLOSE_CHANNEL, eCCT_PKT_OPER_STATUS,   eCCT_PKT_FORCE_CLOSE, eCT_PKT_SERVER_DIE, eCCT_PKT_THE_END }
	Packet types used in the cctalk sub-system. More...

---

Typedef Documentation

typedef unsigned short tCHECKSUM

This is the checksum typedef at the moment it is a 16-bit value. The checksum test will be based on a 16-bit CRC value this is not so much for unreliable communications but more to prove a packet have been receive successfully as there are no restrictions on the data format and the magic number could be seen in the data payload.

---

Enumeration Type Documentation

enum eCCTALK_PACKET_CONSTANTS

Global constants used by the cctalk client server packet code. Enumeration values: eCCT_PKT_VERSION  This is the current version of the cctalk packets for Tx over the packet interface eCCT_PKT_IDENTIFIER  The cctalk packet magic number

enum eCCTALK_PACKET_TYPES

Packet types used in the cctalk sub-system. These packet definitions are used for communication between the cctalk client and the cctalk server. These definitions are not used outside the client server communication realm. Enumeration values: eCCT_PKT_NOT_USED  Never use for a packet type eCCT_PKT_ERROR_MSG  the packet type used by the server to return error codes to the client eCCT_PKT_OPERATION  packet type is set to this for cctalk operation packets eCCT_PKT_GET_OPER  Sent to the server when a client is looking for a finished operation eCCT_PKT_OP_REPLY  The message sent back to the client when a request for a finished cct op is received eCCT_PKT_OPEN_CHANNEL  Open a cctalk channel eCCT_PKT_CLOSE_CHANNEL  Close a channel as needed eCCT_PKT_OPER_STATUS  Sent to the server to find out if there are any more outstanding transactions for this socket. eCCT_PKT_FORCE_CLOSE  This message is send by the client to force a close of a cctalk channel. This channel is closed now and no waiting for data to be read out or send over the serial port is performed. Any transactions in progress at the time of this call are set to be deleted at well eCT_PKT_SERVER_DIE  Called when the client want the server to stop operation and close normally

---