OSAPI AutoSAR

AutoSAR System API. More...

Classes
struct	OSAPI_PortProperty
	AutoSAR System properties. More...

Typedefs
typedef Std_ReturnType(*	NETIO_Autosar_TcpIp_get_socket )(TcpIp_DomainType domain, TcpIp_ProtocolType protocol, TcpIp_SocketIdType *socket)
	Function used to create a socket. Users must provide this function in case SocketOwner is used. The implementation of this function normally calls TcpIp_<Up>GetSocket().
typedef Std_ReturnType(*	NETIO_Autosar_TcpIp_send_dyn_data )(void const *data_ptr, uint16 length, TcpIp_SockAddrType const *remote_addr_ptr)
	Function used to send data. Users must provide this function only in case SocketOwner is not used. If SocketOwner is used RTI Connext Micro will use a socket to send UDP packets.

Enumerations
enum	OSAPI_Autosar_SyncKind_T { OSAPI_AUTOSAR_SYNCKIND_RESOURCES }
	Synchronization method enum. More...

Functions
boolean	NETIO_Autosar_TcpIp_pdu_callout (PduIdType rx_pdu_id, PduInfoType const *pdu_info_ptr)
	This callback can be used only when SocketOwner is NOT configured. Callback function to be called on UDP packet reception.
void	NETIO_Autosar_TcpIp_udp_rx_indication (TcpIp_SocketIdType socket, TcpIp_SockAddrType const *remote_addr_ptr, uint8 *buf_ptr, uint16 length)
	Callback function to be called on UDP packet reception.

Variables
uint32	OSAPI_PortProperty::log_dst_address
uint16	OSAPI_PortProperty::log_dst_port

---

Detailed Description

AutoSAR System API.

The AutoSAR System is defined as specific functionality needed to run RTI Connext Micro on an AutoSAR based OS.

---

Typedef Documentation

typedef Std_ReturnType(* NETIO_Autosar_TcpIp_get_socket)(TcpIp_DomainType domain, TcpIp_ProtocolType protocol, TcpIp_SocketIdType *socket)

Function used to create a socket. Users must provide this function in case SocketOwner is used. The implementation of this function normally calls TcpIp_<Up>GetSocket().

Parameters:

[in]	domain	- IP address family.
[in]	protocol	- Socket protocol as sub-family of parameter type.
[out]	socket	- Pointer to socket identifier representing the requested socket. This socket identifier must be provided for all further API calls which requires a SocketId. Note: value of 'socket' parameter is only valid if return value is E_OK

Returns:

E_OK on success, error code on failure.

typedef Std_ReturnType(* NETIO_Autosar_TcpIp_send_dyn_data)(void const *data_ptr, uint16 length, TcpIp_SockAddrType const *remote_addr_ptr)

Function used to send data. Users must provide this function only in case SocketOwner is not used. If SocketOwner is used RTI Connext Micro will use a socket to send UDP packets.

Parameters:

[in]	data_ptr	- Pointer to data to send.
[in]	length	- Length of data to send.
[in]	remote_addr_ptr	- Address and port where to send the data.

Returns:

E_OK on success, error code on failure.

---

Enumeration Type Documentation

enum OSAPI_Autosar_SyncKind_T

Synchronization method enum.

Enumerator:

OSAPI_AUTOSAR_SYNCKIND_RESOURCES

Use Resources as synchronization method. Use spinlock as synchronization method.

---

Function Documentation

boolean NETIO_Autosar_TcpIp_pdu_callout	(	PduIdType	rx_pdu_id,
		PduInfoType const *	pdu_info_ptr
	)

This callback can be used only when SocketOwner is NOT configured. Callback function to be called on UDP packet reception.

Parameters:

[in]	rx_pdu_id	Rx PDU id.
[in]	pdu_info_ptr	Pointer to PDU information

Returns:

TRUE on success, FALSE on failure.

void NETIO_Autosar_TcpIp_udp_rx_indication	(	TcpIp_SocketIdType	socket,
		TcpIp_SockAddrType const *	remote_addr_ptr,
		uint8 *	buf_ptr,
		uint16	length
	)

Callback function to be called on UDP packet reception.

This callback can be used only when SocketOwner is configured.

Parameters:

[in]	socket	Local socket ID. Use 0 if SocketOwner is not configured.
[in]	remote_addr_ptr	Pointer to remote address. Can be NULL_PTR if unknown.
[in]	buf_ptr	Pointer to buffer with incoming data.
[in]	length	Length of incoming data

---

Variable Documentation

uint32 OSAPI_PortProperty::log_dst_address

Destination IP address used to send logs to. The format of the address must be compatible with the format needed for function TcpIp_UdpTransmit(), that is in host format instead of network format. I.e. 0xCA00A8C0 would be IP address 192.168.0.202. If 0, logs will not be send to any address. This is the default value.

uint16 OSAPI_PortProperty::log_dst_port

Destination IP port used to send logs to. The format of the port must be compatible with the format needed for function TcpIp_UdpTransmit().