API Documentation

Enumerations

Core Module Enumerations

ps_datarate_kind

Datarate kinds.

Value Description
DATARATE_INVALID Invalid datarate kind.
DATARATE_UNKNOWN Unknown datarate kind.
DATARATE_NA Datarate kind not available.
DATARATE_1200 1200 bit/s.
DATARATE_1800 1800 bit/s.
DATARATE_2400 2400 bit/s.
DATARATE_4800 4800 bit/s.
DATARATE_9600 9600 bit/s.
DATARATE_19200 19200 bit/s.
DATARATE_38400 38400 bit/s.
DATARATE_57600 57600 bit/s.
DATARATE_115200 115200 bit/s.
DATARATE_230400 230400 bit/s.
DATARATE_100K 100 kbit/s.
DATARATE_125K 125 kbit/s.
DATARATE_250K 250 kbit/s.
DATARATE_500K 500 kbit/s.
DATARATE_1M 1 Mbit/s.
DATARATE_KIND_COUNT Number of ps_datarate_kind values.

ps_file_transfer_mode_kind

File transfer mode kinds.

Value Description
FILE_TRANSFER_MODE_INVALID Invalid file transfer mode kind.
FILE_TRANSFER_MODE_READ File transfer mode read. Open file for reading.
FILE_TRANSFER_MODE_WRITE File transfer mode write. Open file for writing. If the file already exist, its contents are overwritten.
FILE_TRANSFER_MODE_APPEND File transfer mode append. Open file for appending.
FILE_TRANSFER_MODE_KIND_COUNT Number of ps_file_transfer_mode_kind values.

ps_log_level_kind

Log level kinds.

Value Description
LOG_LEVEL_DEBUG Log with debug level.
LOG_LEVEL_INFO Log with informative level.
LOG_LEVEL_WARN Log with warning level.
LOG_LEVEL_ERROR Log with error level.
LOG_LEVEL_KIND_COUNT Number of ps_log_level_kind values.

ps_logfile_mode_kind

Logfile mode kinds.

Value Description
LOGFILE_MODE_INVALID Invalid logfile mode.
LOGFILE_MODE_OFF Logfile is not open.
LOGFILE_MODE_READ Logfile is open for reading.
LOGFILE_MODE_WRITE Logfile is open for writing.
LOGFILE_MODE_KIND_COUNT Number of ps_logfile_mode_kind values.

ps_logfile_state_kind

Logfile state kinds.

Value Description
LOGFILE_STATE_INVALID Invalid logfile state.
LOGFILE_STATE_DISABLED Logfile is disabled (i.e. paused).
LOGFILE_STATE_ENABLED Logfile is enabled.
LOGFILE_STATE_KIND_COUNT Number of ps_logfile_state_kind values.

ps_network_interface_kind

Network interface kinds.

Value Description
NETWORK_INTERFACE_INVALID Invalid network interface kind.
NETWORK_INTERFACE_UNKNOWN Unknown network interface kind.
NETWORK_INTERFACE_NOT_AVAILABLE Network interface kind not available.
NETWORK_INTERFACE_AUTO Interface is set to “AUTO.”
NETWORK_INTERFACE_LO Loop-back interface.
NETWORK_INTERFACE_WLAN0 Wireless interface 0.
NETWORK_INTERFACE_WLAN1 Wireless interface 1.
NETWORK_INTERFACE_WLAN2 Wireless interface 2.
NETWORK_INTERFACE_WLAN3 Wireless interface 3.
NETWORK_INTERFACE_ETH0 Ethernet interface 0.
NETWORK_INTERFACE_ETH1 Ethernet interface 1.
NETWORK_INTERFACE_ETH2 Ethernet interface 2.
NETWORK_INTERFACE_ETH3 Ethernet interface 3.
NETWORK_INTERFACE_ETH4 Ethernet interface 4.
NETWORK_INTERFACE_ETH5 Ethernet interface 5.
NETWORK_INTERFACE_ETH6 Ethernet interface 6.
NETWORK_INTERFACE_ETH7 Ethernet interface 7.
NETWORK_INTERFACE_ETH8 Ethernet interface 8.
NETWORK_INTERFACE_ETH9 Ethernet interface 9.
NETWORK_INTERFACE_KIND_COUNT Number of ps_network_interface_kind values.

ps_node_flag_kind

Node flag kinds for PolySync diagnostic state messages.

The node flag kinds are used with ps_diagnostic_state to indicate the operating status or mode.

Value Description
NODE_FLAG_VALID Node is valid.
NODE_FLAG_DEBUG Debug enabled.
NODE_FLAG_HANDLERS_ENABLED Core/user on_data handlers are enabled.
NODE_FLAG_RNR_CLOCK_OWNER PolySync RnR clock was started/owned by this node.
NODE_FLAG_PTP_DETECTED PTP service detected or in-use.
NODE_FLAG_LOGFILE_ENABLED Logfile service detected or in-use.
NODE_FLAG_MANAGER_DETECTED PolySync manager service detected or in-use.
NODE_FLAG_KIND_COUNT Number of ps_node_flag_kind values.

ps_node_state_kind

Node state kinds used by the PolySync node state machine.

Node states are referenced in the PolySync node template, and define all possible states a node may operate in. While conforming to the PolySync node template a user must manually transition a node from one state to another.

Value Description
NODE_STATE_INVALID Invalid node state.
NODE_STATE_AUTH Node is being authenticated, is not a valid domain participant, and does not have a GUID.
NODE_STATE_INIT Node is initializing, is a valid domain participant, and has a GUID.
NODE_STATE_OK Node is running.
NODE_STATE_WARN Fault code is set. May lead to a failure. Fault is not fatal to the operation or the application. Node can continue normal operation and can possibly recover. Node typically can auto-recover without intervention.
NODE_STATE_ERROR Fault code is set. Failure will occur. Fault is fatal to the operation but NOT the application. Node can NOT continue normal operation. User intervention typically required to recover.
NODE_STATE_FATAL Fault code is set. Failure will occur. Fault is fatal to the operation AND the application. Node can NOT continue normal operation and may terminate to prevent data loss or further data loss. User intervention typically required to recover.
NODE_STATE_KIND_COUNT Number of ps_node_state_kind values.

ps_parameter_message_kind

Parameter message kinds.

Value Description
PARAMETER_MESSAGE_INVALID Invalid parameter message kind.
PARAMETER_MESSAGE_UNKNOWN Unknown parameter message kind.
PARAMETER_MESSAGE_RESPONSE Message is a parameter response.
PARAMETER_MESSAGE_GET_VALUE Message is a command to get parameter value(s) without descriptions.
PARAMETER_MESSAGE_GET_ALL Message is a command to get all parameters (both description and value).
PARAMETER_MESSAGE_SET_VALUE Message is a command to set parameter value(s). Not supported if parameter value is read-only.
PARAMETER_MESSAGE_SET_MIN Message is a command to set parameter range minimum value(s). Not supported if parameter minimum value is read-only.
PARAMETER_MESSAGE_SET_MAX Message is a command to set parameter range maximum value(s). Not supported if parameter maximum value is read-only.
PARAMETER_MESSAGE_SET_STEP Message is a command to set parameter range step value(s). Not supported if parameter set step is read-only.
PARAMETER_MESSAGE_SET_VALUE_MIN_MAX Message is a command to set parameter range value, minimum, and maximum value(s). Not supported if parameter value/min/max is read-only.
PARAMETER_MESSAGE_KIND_COUNT Number of ps_parameter_message_kind values.

ps_parameter_value_kind

Parameter value kinds.

Value Description
PARAMETER_VALUE_UNKNOWN Unknown parameter value kind.
PARAMETER_VALUE_ULONGLONG Parameter value type is unsigned long long.
PARAMETER_VALUE_LONGLONG Parameter value type is long long.
PARAMETER_VALUE_DOUBLE Parameter value type is double.
PARAMETER_VALUE_STRING Parameter value type is char sequence.
PARAMETER_VALUE_KIND_COUNT Number of ps_parameter_value_kind values.

ps_pixel_format_kind

Pixel format kinds.

Value Description
PIXEL_FORMAT_INVALID Invalid pixel format kind.
PIXEL_FORMAT_UNKNOWN Unknown pixel format kind.
PIXEL_FORMAT_NOT_AVAILABLE Pixel format kind not available.
PIXEL_FORMAT_MJPEG MJPEG multiplexed stream, compressed format.
PIXEL_FORMAT_MPEG MPEG multiplexed stream, compressed format.
PIXEL_FORMAT_H264 H264 video elementary stream with start codes, compressed format.
PIXEL_FORMAT_MPEG1 MPEG1 video elementary stream, compressed format.
PIXEL_FORMAT_MPEG2 MPEG2 video elementary stream, compressed format.
PIXEL_FORMAT_MPEG4 MPEG4 video elementary stream, compressed format.
PIXEL_FORMAT_BGR24 BGR3, packed RGB format.
PIXEL_FORMAT_RGB24 BGR3, packed RGB format.
PIXEL_FORMAT_RGB24 RGB3, packed RGB format.
PIXEL_FORMAT_YUV444 YUV444, packed YUV format.
PIXEL_FORMAT_YUV555 YUVO, packed YUV format.
PIXEL_FORMAT_YUV565 YUVP, packed YUV format.
PIXEL_FORMAT_YUV32 YUV4, packed YUV format.
PIXEL_FORMAT_GREY Grey-scale, YUV format.
PIXEL_FORMAT_YUYV YUYV, packed YUV format with 12 horizontal chroma resolution, also known as YUV 4:2:2.
PIXEL_FORMAT_Y41P Y41P, packed YUV format with 14 horizontal chroma resolution, also known as YUV 4:1:1.
PIXEL_FORMAT_YUV411P 411P, planar YUV format with 14 horizontal chroma resolution, also known as YUV 4:1:1.
PIXEL_FORMAT_YUV420 YU12, planar YUV format with 12 horizontal and vertical chroma resolution, also known as YUV 4:2:0.
PIXEL_FORMAT_YUV422P 422P, planar YUV format with 12 horizontal chroma resolution, also known as YUV 4:2:2.
PIXEL_FORMAT_KIND_COUNT Number of ps_pixel_format_kind values.

ps_reliability_qos_kind

Reliability QoS kinds.

Value Description
RELIABILITY_QOS_INVALID Invalid reliability QoS kind.
RELIABILITY_QOS_UNKNOWN Unknown reliability QoS kind.
RELIABILITY_QOS_AVAILABLE Reliability QoS kind not available.
RELIABILITY_QOS_DEFAULT Default API provided reliability QoS.
RELIABILITY_QOS_BEST_EFFORT Best effort reliability QoS.
RELIABILITY_QOS_RELIABLE Reliable reliability QoS.
RELIABILITY_QOS_KIND_COUNT Number of ps_reliability_qos_kind values.

ps_rnr_msg_kind

Record and Replay message kinds. Valid values for ps_rnr_msg type field. Some types will use the ps_rnr_msg control_data field for additional data. Unknown types will be ignored, where as invalid types could be handled as errors.

Value Description
RNR_MSG_INVALID Invalid RnR message kind.
RNR_MSG_UNKNOWN Unknown RnR message kind.
RNR_MSG_STATUS Status of producer’s RnR utilities. All common fields of the ps_rnr_msg are filled by the producer, and reflect its logfile data. Does not use the control_data field.
RNR_MSG_REPLAY_SYNC_TIME_SET An update to the Nearest Common Replay Timestamp by the producer. The timestamp is stored in the control_data field, type unsigned long long. [microseconds]
RNR_MSG_REPLAY_SYNC_WAIT Producer is waiting for other nodes to sync their replay logfile session to the Nearest Common Replay Timestamp. The number of node’s the producer is waiting on (per host) is stored in the control_data field, type unsigned long long.
RNR_MSG_SET_FILE_NAME Manually set the RnR session file name. this is usually handled automatically by the Logfile API, but can be set manually. The file name string is stored in the control_data field, type string.
RNR_MSG_SET_MODE Set producer’s logfile mode and session identifier. The desired mode is indicated by the mode field. The desired session identifier is indicated by the session_id field.
RNR_MSG_SET_STATE Set producer’s logfile state. This is used to pause/resume the logfile’s current mode. If using to start/resume read mode, an optional absolute UTC microsecond start time can be specified using the control_data field, type unsigned long long. If value type is PARAMETER_VALUE_UNKNOWN or value is zero, replay starts immediately. The desired state is indicated by the state field.
RNR_MSG_SET_REPLAY_POSITION Set producer’s logfile current replay position timestamp. This is used to provide a seek mechanism. The timestamp value is between the beginning and end timestamps of the producer’s logfile. The producer will set its position to the entry that has a timestamp nearest the specified value. The desired position timestamp is indicated by the current_timestamp field.
RNR_MSG_SET_REPLAY_CLOCK_SCALE Set producer’s logfile replay clock scale. This value applies a scaling factor to the replay system clock. 1.0 means no effect. Less than 1.0 means to slow down. Greater than 1.0 means to speed up. The desired value is indicated by the clock_scale field.
RNR_MSG_STEP_REPLAY_FORWARD Step producer’s logfile replay record entry forward. If producer is (paused) in mode LOGFILE_MODE_READ, and state LOGFILE_STATE_DISABLED, then this will cause the producer to replay the next message in the logfile.
RNR_MSG_STEP_REPLAY_BACKWARD Step producer’s logfile replay record entry backward. If producer is (paused) in mode LOGFILE_MODE_READ, and state LOGFILE_STATE_DISABLED, then this will cause the producer to replay the previous message in the logfile.
RNR_MSG_GET_RNR_SESSIONS Get all RnR sessions available on the receiver’s host. Ihis is usually handled by the PolySync Manager node, and will be followed with a response ps_rnr_sessions_msg message. No other fields in ps_rnr_msg are used.
RNR_MSG_KIND_COUNT Number of ps_rnr_msg values.

ps_signal_kind

Signal kinds.

Value Description
SIGNAL_INVALID Invalid signal kind.
SIGNAL_UNKNOWN Unknown signal kind.
SIGNAL_NOT_AVAILABLE Signal kind not available.
SIGNAL_DIGITAL_INPUT Digital input signal.
SIGNAL_DIGITAL_OUTPUT Digital output signal.
SIGNAL_ANALOG_INPUT Analog input signal.
SIGNAL_ANALOG_OUTPUT Analog output signal.
SIGNAL_KIND_COUNT Number of ps_signal_kind values.