在 TCP 层序列化和反序列化真实载荷
TCP 载荷数据需要被转换为字符串,并存储在分段与重组缓冲区中。这些字符串作为数据包载荷传输时,在传输线路上以比特表示。载荷在发送节点进入缓冲区时必须被序列化,然后在接收节点从缓冲区传出时被反序列化,如本节所述。
注: 必须注册序列化和反序列化回调函数。
真实载荷的序列化
要对真实载荷进行序列化,回调函数首先通过为临时存放载荷序列化内容的缓冲区指定一个近似大小来创建载荷句柄。然后回调通过调用相应的 API(基于被序列化的数据类型)来序列化数据。当所有数据都已序列化并存储在临时缓冲区后,回调函数调用 oms_sar_payload_serialized_bytes_get 获取序列化后的字节,用于填充传入回调的缓冲区。
真实载荷的反序列化
要对真实载荷进行反序列化,反序列化回调通过传入待反序列化的字节串来创建载荷句柄。然后回调按照与序列化时相同的顺序调用各个 API,将字节串转换为相应类型的数据。随后回调创建所需类型的数据包,填入通过反序列化载荷获得的数据,并返回一个数据包。
注: 当 SAR 包的客户端(例如 TCP)请求访问或从缓冲区移除数据时,请求的数据量必须是 8 比特的整数倍。如果不是 8 的整数倍,SAR 包将创建一个段,其比特数为小于请求大小的最接近的 8 的整数倍。
真实载荷序列化/反序列化示例函数
下面的示例展示了如何编写序列化和反序列化函数。
Compcode
tcp_sar_serialization_callback (Packet* packet, char **data_arr,
OpT_Packet_Size *array_size)
{
OmsT_Payload_Handle *payload_handle_ptr = OPC_NIL;
int tos = 0, options = 0;
double ratio = 0.0;
FIN (tcp_sar_serialization_callback);
/* Create the payload handle. */
payload_handle_ptr = oms_sar_payload_serializer_handle_create (
op_pk_total_size_get (packet));
/* Serialize the data from the packet. */
/* Get the data from the packets. */
op_pk_nfd_get_int32 (packet, "Type of Service", &tos);
op_pk_nfd_get_int32 (packet, "Options", &options);
op_pk_nfd_get_dbl (packet, "Ratio", &ratio);
/* Store the serialized data in the buffer. */
oms_sar_payload_int32_serialize (payload_handle_ptr, tos);
oms_sar_payload_int32_serialize (payload_handle_ptr, options);
oms_sar_payload_double_serialize (payload_handle_ptr, ratio);
/* Get the serialized data from the buffer. */
oms_sar_payload_serialized_bytes_get (payload_handle_ptr, data_arr,
array_size);
/* Destroy the payload handle */
oms_sar_payload_handle_destroy (&payload_handle_ptr);
FRET (OPC_COMPCODE_SUCCESS);
}
Packet*
tcp_sar_deserialization_callback (char *data_arr, OpT_Int64 array_size,
OpT_Packet_Size *data_converted)
{
OmsT_Payload_Handle *payload_handle_ptr = OPC_NIL;
int tos = 0, options = 0;
double ratio = 0.0;
Packet *packet_ptr = OPC_NIL;
FIN (tcp_sar_deserialization_callback);
/* Create the payload handle. */
payload_handle_ptr = oms_sar_payload_deserializer_handle_create (
data_arr, array_size);
/* Get the data from the payload. */
oms_sar_payload_int32_deserialize (payload_handle_ptr, &tos);
oms_sar_payload_int32_deserialize (payload_handle_ptr, &options);
oms_sar_payload_double_deserialize (payload_handle_ptr, &ratio);
/* Create a packet of the required type and fill in the data. */
packet_ptr = op_pk_create_fmt ("tcp_data_packet");
if (packet_ptr)
{
op_pk_nfd_set_int32 (packet_ptr, "Type of Service", tos);
op_pk_nfd_set_int32 (packet_ptr, "Options", options);
op_pk_nfd_set_dbl (packet_ptr, "Ratio", ratio);
}
/* Fill in the number of bytes of payload deserialized. */
*data_converted = sizeof(int)*2 + sizeof(double);
/* Destroy the payload handle */
oms_sar_payload_handle_destroy (&payload_handle_ptr);
FRET (packet_ptr);
}
这些函数应定义在一个 ex.cpp 文件中,并且该文件必须包含 oms_sar_payload_support.h。该文件还必须在仿真场景或相关的进程模型中声明,使用 File > Declare External Files。注意,每个 TCP 连接可以注册一个序列化回调和一个反序列化回调。如果客户端发送多种类型的数据包,应在同一个回调内处理这些类型。
注册真实载荷的序列化/反序列化函数
TCP 的客户端必须为真实载荷注册序列化和反序列化回调。
如果客户端使用 InetT_Address 结构,客户端必须使用以下 API 打开 TCP 连接:
tcp_connection_open_with_options(ApiT_Tcp_App_Handle* tcp_hndl_ptr,
InetT_Address rem_addr, TcpT_Port remote_port, int command,
TcpT_Conn_Open_Options* options)
在传入的 TcpT_Conn_Open_Options 结构中,客户端应设置序列化和反序列化回调:
options->ser_callbacks_ptr->serialize_func = tcp_sar_serialization_callback;
options->ser_callbacks_ptr->deserialize_func =
tcp_sar_deserialization_callback;
注: 要创建 InetT_Address 结构,可以使用 inet_address_create (const char* ip_addr_str, InetT_Addr_Family addr_family) API。
如果客户端使用 IpT_Address 结构,客户端必须使用以下 API 打开 TCP 连接:
tcp_connection_with_source_open_core (ApiT_Tcp_App_Handle*
tcp_hndl_ptr, IpT_Address rem_addr, TcpT_Port rem_port, IpT_Address
local_addr, TcpT_Port loc_port, int command, int ip_qos,
OmsT_Sar_Packet_Serialize_Cback ser_func,
OmsT_Sar_Packet_Deserialize_Cback deser_func)
注: 要创建 IpT_Address 结构,可以使用 ip_address_create (const char *addr_str) API。
注意,tcp_sar_serialization_callback 和 tcp_sar_deserialization_callback 只是示例。它们可以是你在本文档上一节中创建的任何函数名称。
有关这些 API 的更多信息,请参考 ip_addr_v4 外部源模型。