net_common.h

Go to the documentation of this file.

 
#ifndef NET_COMMON_H
#define NET_COMMON_H
 
#define FED_COM_BUFFER_SIZE 256u
 
#define ADDRESS_QUERY_RETRY_INTERVAL MSEC(250)
 
#define DELAY_START SEC(1)
 
 
// These message types will be encoded in an unsigned char,
// so the magnitude must not exceed 255. Note that these are
// listed in increasing numerical order starting from 0 interleaved
// with decreasing numerical order starting from 255 (so that they
// can be listed in a logical order here even as the design evolves).
 
#define MSG_TYPE_REJECT 0
 
#define MSG_TYPE_ACK 255
 
#define MSG_TYPE_UDP_PORT 254
 
#define MSG_TYPE_FED_IDS 1
 
 
#define MSG_TYPE_FED_NONCE 100
 
#define MSG_TYPE_RTI_RESPONSE 101
 
#define MSG_TYPE_FED_RESPONSE 102
 
#define NONCE_LENGTH 8
 
#define SHA256_HMAC_LENGTH 32
 
#define MSG_TYPE_TIMESTAMP 2
#define MSG_TYPE_TIMESTAMP_LENGTH (1 + sizeof(int64_t))
 
#define MSG_TYPE_MESSAGE 3
 
#define MSG_TYPE_RESIGN 4
 
#define MSG_TYPE_TAGGED_MESSAGE 5
 
#define MSG_TYPE_NEXT_EVENT_TAG 6
 
#define MSG_TYPE_TAG_ADVANCE_GRANT 7
 
#define MSG_TYPE_PROVISIONAL_TAG_ADVANCE_GRANT 8
 
#define MSG_TYPE_LATEST_TAG_CONFIRMED 9
 
 
#define MSG_TYPE_STOP_REQUEST 10
#define MSG_TYPE_STOP_REQUEST_LENGTH (1 + sizeof(instant_t) + sizeof(microstep_t))
#define ENCODE_STOP_REQUEST(buffer, time, microstep)                                                                   \
  do {                                                                                                                 \
    buffer[0] = MSG_TYPE_STOP_REQUEST;                                                                                 \
    encode_int64(time, &(buffer[1]));                                                                                  \
    encode_int32((int32_t)microstep, &(buffer[1 + sizeof(instant_t)]));                                                \
  } while (0)
 
#define MSG_TYPE_STOP_REQUEST_REPLY 11
#define MSG_TYPE_STOP_REQUEST_REPLY_LENGTH (1 + sizeof(instant_t) + sizeof(microstep_t))
#define ENCODE_STOP_REQUEST_REPLY(buffer, time, microstep)                                                             \
  do {                                                                                                                 \
    buffer[0] = MSG_TYPE_STOP_REQUEST_REPLY;                                                                           \
    encode_int64(time, &(buffer[1]));                                                                                  \
    encode_int32((int32_t)microstep, &(buffer[1 + sizeof(instant_t)]));                                                \
  } while (0)
 
#define MSG_TYPE_STOP_GRANTED 12
#define MSG_TYPE_STOP_GRANTED_LENGTH (1 + sizeof(instant_t) + sizeof(microstep_t))
#define ENCODE_STOP_GRANTED(buffer, time, microstep)                                                                   \
  do {                                                                                                                 \
    buffer[0] = MSG_TYPE_STOP_GRANTED;                                                                                 \
    encode_int64(time, &(buffer[1]));                                                                                  \
    encode_int32((int32_t)microstep, &(buffer[1 + sizeof(instant_t)]));                                                \
  } while (0)
 
 
#define MSG_TYPE_ADDRESS_QUERY 13
 
#define MSG_TYPE_ADDRESS_QUERY_REPLY 14
 
#define MSG_TYPE_ADDRESS_ADVERTISEMENT 15
 
#define MSG_TYPE_P2P_SENDING_FED_ID 16
 
#define MSG_TYPE_P2P_MESSAGE 17
 
#define MSG_TYPE_P2P_TAGGED_MESSAGE 18
 
 
/*
 * The next 8 bytes will be a timestamp sent according to
 * PTP.
 */
#define MSG_TYPE_CLOCK_SYNC_T1 19
 
/*
 * Prompts the master to send a T4.
 * The next four bytes will be the sendin federate's id
 */
#define MSG_TYPE_CLOCK_SYNC_T3 20
 
/*
 * The next 8 bytes will be a timestamp sent according to
 * PTP.
 */
#define MSG_TYPE_CLOCK_SYNC_T4 21
 
#define MSG_TYPE_CLOCK_SYNC_CODED_PROBE 22
 
#define MSG_TYPE_PORT_ABSENT 23
 
#define MSG_TYPE_NEIGHBOR_STRUCTURE 24
#define MSG_TYPE_NEIGHBOR_STRUCTURE_HEADER_SIZE 9
 
#define MSG_TYPE_FAILED 25
 
 
#define FEDERATION_ID_DOES_NOT_MATCH 1
 
#define FEDERATE_ID_IN_USE 2
 
#define FEDERATE_ID_OUT_OF_RANGE 3
 
#define UNEXPECTED_MESSAGE 4
 
#define WRONG_SERVER 5
 
#define HMAC_DOES_NOT_MATCH 6
 
#define RTI_NOT_EXECUTED_WITH_AUTH 7
 
#endif /* NET_COMMON_H */