ds_shared.h File Reference

Message codes and structure definition for the Device Service library. More...

#include "trek_toolkit_common_api_ansi_c.h"
#include <time.h>

Data Structures
struct	cfdp_struct_type
	Structure of parameters needed for CFDP transaction status. More...
struct	ip_address_struct_type
	Structure of parameters needed for IP address identification. More...
struct	record_device_struct_type
	Structure of parameters needed for record device status. More...
struct	dropbox_device_struct_type
	Structure of parameters needed for dropbox device status. More...

Macros
#define	DS_UNDEFINED   0x00000001
	1 DS message code for Undefined
#define	DS_METADATA   0x00000002
	2 DS message code for Metadata
#define	DS_OPEN   0x00000003
	3 DS message code for Open
#define	DS_CLOSE   0x00000004
	4 DS message code for Close
#define	DS_READ   0x00000005
	5 DS message code for Read
#define	DS_WRITE   0x00000006
	6 DS message code for Write
#define	DS_START   0x00000007
	7 DS message code for Start
#define	DS_STOP   0x00000008
	8 DS message code for Stop
#define	DS_PAUSE   0x00000009
	9 DS message code for Pause
#define	DS_RESUME   0x0000000A
	10 DS message code for Resume
#define	DS_PULSE   0x0000000B
	11 DS message code for Pulse
#define	DS_CONFIGURE   0x0000000C
	12 DS message code for Configure
#define	DS_SET   0x0000000D
	13 DS message code for Set
#define	DS_ACCEPT_CONNECTION   0x0000000E
	14 DS message code for Accept Connection
#define	DS_CLOSE_SERVER_CONNECTION   0x0000000F
	15 DS message code for Close Server Connection
#define	DS_CLOSE_CLIENT_CONNECTION   0x00000010
	16 DS message code for Close Client Connection
#define	DS_DEVICE_STATE_UNDEFINED   0x00000011
	17 DS message code for Device State Undefined
#define	DS_DEVICE_READY_TO_RECEIVE   0x00000012
	18 DS message code for Device Ready To Receive
#define	DS_DEVICE_RECEIVING   0x00000013
	19 DS message code for Device Receiving
#define	DS_DEVICE_NOT_RECEIVING   0x00000014
	20 DS message code for Device Not Receiving
#define	DS_DEVICE_READY_TO_SEND   0x00000015
	21 DS message code for Device Ready To Send
#define	DS_DEVICE_SENDING   0x00000016
	22 DS message code for Device Sending
#define	DS_DEVICE_NOT_SENDING   0x00000017
	23 DS message code for Device Not Sending
#define	DS_PACKET_STATE_UNDEFINED   0x00000018
	24 DS message code for Packet State Undefined
#define	DS_PACKET_READY_TO_RECEIVE   0x00000019
	25 DS message code for Packet Ready To Receive
#define	DS_PACKET_RECEIVING   0x0000001A
	26 DS message code for Packet Receiving
#define	DS_PACKET_NOT_RECEIVING   0x0000001B
	27 DS message code for Packet Not Receiving
#define	DS_PACKET_READY_TO_SEND   0x0000001C
	28 DS message code for Packet Ready To Send
#define	DS_PACKET_SENDING   0x0000001D
	29 DS message code for Packet Sending
#define	DS_PACKET_NOT_SENDING   0x0000001E
	30 DS message code for Packet Not Sending
#define	DS_COMMAND   0x0000001F
	31 DS message code for Command
#define	DS_END   0x00000020
	32 DS message code for End
#define	DS_PATH_AND_FILENAME   0x00000021
	33 DS message code for Path And Filename
#define	DS_CLOCK_SIGNAL   0x00000022
	34 DS message code for Clock Signal
#define	DS_CREATE   0x00000023
	35 DS message code for Create
#define	DS_DESTROY   0x00000024
	36 DS message code for Destroy
#define	DS_REPORT   0x00000025
	37 DS message code for Report
#define	DS_SUSPEND   0x00000026
	38 DS message code for Suspend
#define	DS_CANCEL   0x00000027
	39 DS message code for Cancel
#define	DS_SUCCESS   0x00000028
	40 DS message code for Success
#define	DS_FAIL   0x00000029
	41 DS message code for Fail
#define	DS_ABANDON   0x0000002A
	42 DS message code for Abandon
#define	DS_UNKNOWN   0x0000002B
	43 DS message code for Unknown
#define	DS_RESET   0x0000002C
	44 DS message code for Reset
#define	DS_MESSAGE   0x0000002D
	45 DS message code for Message
#define	DS_FINISH   0x0000002E
	46 DS message code for Finish
#define	DS_ERROR   0x0000002F
	47 DS message code for Error
#define	DS_CONNECT   0x00000030
	48 DS message code for Connect
#define	DS_ACCEPT   0x00000031
	49 DS message code for Accept
#define	DS_DELETE   0x00000032
	50 DS message code for Delete
#define	DS_GENERATE   0x00000033
	51 DS message code for Generate
#define	DS_ADD   0x00000034
	52 DS message code for Add
#define	DS_REMOVE   0x00000035
	53 DS message code for Remove
#define	DS_ENCRYPT_FILE   0x00000036
	54 DS message code for Encrypt File
#define	DS_DECRYPT_FILE   0x00000037
	55 DS message code for Decrypt File
#define	DS_NOTIFY   0x00000038
	56 DS message code for Notify
#define	DS_TEST   0x00000039
	57 DS message code for Test
#define	DS_VERIFY   0x0000003A
	58 DS message code for Verify
#define	DS_EMAIL   0x0000003B
	59 DS message code for Email
#define	DS_TEXTING   0x0000003C
	60 DS message code for Texting
#define	DS_ADD_TO_ADDRESS   0x0000003D
	61 DS message code for Add To Address
#define	DS_ADD_CC_ADDRESS   0x0000003E
	62 DS message code for Add Cc Address
#define	DS_ADD_PHONE_NUMBER   0x0000003F
	63 DS message code for Add Phone Number
#define	DS_REMOVE_TO_ADDRESS   0x00000040
	64 DS message code for Remove To Address
#define	DS_REMOVE_CC_ADDRESS   0x00000041
	65 DS message code for Remove Cc Address
#define	DS_REMOVE_PHONE_NUMBER   0x00000042
	66 DS message code for Remove Phone Number
#define	DS_TWELVE_AND_TWENTY_FOUR   0x00000043
	67 DS message code for Twelve and Twenty Four hour
#define	DS_TWENTY_FOUR   0x00000044
	68 DS message code for Twenty Four hour

Enumerations
enum	endian_byte_order {   BIG_ENDIAN_ORDER = 0 ,   LITTLE_ENDIAN_ORDER }
	Byte order enumeration. More...
enum	boolean_type {   FALSE_OR_NO = 0 ,   TRUE_OR_YES }
	Boolean enumeration. More...
enum	ip_address_version_type {   IPV4 = 0 ,   IPV6 }
	IP address version enumeration. More...
enum	cipher_class_type
	Cipher class enumeration.
enum	ip_address_v6_category_type {   UNDEFINED_IP_ADDRESS_V6_CATEGORY = 0 ,   GLOBAL_FIXED ,   GLOBAL_TEMPORARY ,   LINK_LOCAL ,   TAREDO_TUNNELING ,   IPV6_TO_IPV4_TUNNELING ,   MULTICAST ,   OTHER }
	IP version 6 address category. More...

Detailed Description

Message codes and structure definition for the Device Service library.

Enumeration Type Documentation

boolean_type

enum boolean_type

Boolean enumeration.

Enumerator
FALSE_OR_NO	False.
TRUE_OR_YES	True.

endian_byte_order

enum endian_byte_order

Byte order enumeration.

Enumerator
BIG_ENDIAN_ORDER	Also known as network byte order. Most significant byte is first.
LITTLE_ENDIAN_ORDER	Least significant byte is first.

ip_address_v6_category_type

enum ip_address_v6_category_type

IP version 6 address category.

Enumerator
UNDEFINED_IP_ADDRESS_V6_CATEGORY	Undefined.
GLOBAL_FIXED	Global fixed.
GLOBAL_TEMPORARY	GLobal temporary.
LINK_LOCAL	Link local.
TAREDO_TUNNELING	Taredo tunneling.
IPV6_TO_IPV4_TUNNELING	IPv6 to IPv4 tunneling.
MULTICAST	Multicast.
OTHER	Other.

ip_address_version_type

enum ip_address_version_type

IP address version enumeration.

Enumerator
IPV4	IP version 4 address.
IPV6	IP version 6 address.