Portable interface#

sl_iperf_protocol#

sl_iperf_protocol

iPerf socket IP protocol type definition enum

sl_iperf_protocol_t#

typedef enum sl_iperf_protocol sl_iperf_protocol_t

iPerf socket IP protocol type definition enum

sl_iperf_socket_addr_t#

typedef struct sl_iperf_socket_addr sl_iperf_socket_addr_t

Socket address type definition wrapper.

sl_iperf_socket_in6addr_t#

typedef struct sl_iperf_socket_in6addr sl_iperf_socket_in6addr_t

Raw ip address byes.

sl_iperf_time_t#

typedef struct sl_iperf_time sl_iperf_time_t

iPerf time data type definition

sl_iperf_ts_ms_t#

typedef uint64_t sl_iperf_ts_ms_t

iPerf timestamp millisecond data type deifinition

sl_iperf_socket_inaddr_any#

const sl_iperf_socket_in6addr_t sl_iperf_socket_inaddr_any

Anyaddress constant.

sl_iperf_delay_ms#

void sl_iperf_delay_ms (const uint32_t ms)

iPerf millisec delay

Customizable delay function

sl_iperf_get_socket_addr#

__STATIC_INLINE void sl_iperf_get_socket_addr (const sl_iperf_socket_addr_t *const src_addr, void *const dest_addr)

Get socket address.

Create a full copy from iperf source address into the custom destination address.

sl_iperf_get_socket_addr_ip#

void sl_iperf_get_socket_addr_ip (const sl_iperf_socket_addr_t *const addr, void *const ip)

Get IP address bytes from iPerf address structure.

Getter function of IP address

sl_iperf_get_socket_addr_port#

uint16_t sl_iperf_get_socket_addr_port (const sl_iperf_socket_addr_t *const addr)

Get port number of iperf address structure.

Getter function of port property Returns

• uint16_t Port number

sl_iperf_get_timestamp_ms#

sl_iperf_ts_ms_t sl_iperf_get_timestamp_ms (void )

Get millisec timestamp.

Get CPU tick convert to millisec Returns

• sl_iperf_ts_ms_t Timestamp in millisec

sl_iperf_inet_ntop#

const char * sl_iperf_inet_ntop (const sl_iperf_socket_addr_t *const src_addr, char *const dst_str, const size_t size)

Convert IPv4 and IPv6 addresses from binary to text form.

Converts the network address structure src in the af address family into a character string. Returns

• It returns a non-null pointer to dst. NULL is returned if there was an error

sl_iperf_inet_pton#

int32_t sl_iperf_inet_pton (const char * src_str, sl_iperf_socket_addr_t *const dst_addr)

Convert addresses from text to binary form.

It converts the character string src into a network address structure. Returns

• 1 on succes, -1 on error (POSIX described the 0 value too)

sl_iperf_join_multicast_group#

int32_t sl_iperf_join_multicast_group (const int32_t sockid, const sl_iperf_socket_addr_t *const multicast_addr)

Join multicast group.

Join socket to multicast group to get packets on group address Returns

• int32_t

sl_iperf_leave_multicast_group#

int32_t sl_iperf_leave_multicast_group (const int32_t sockid, const sl_iperf_socket_addr_t *const multicast_addr)

Leave multicast group.

Remove socket from multicast group Returns

• int32_t

sl_iperf_network_htonl#

uint32_t sl_iperf_network_htonl (uint32_t val)

iPerf host to network long

htonl implementation for iPerf Returns

• uint32_t Converted value

sl_iperf_network_htons#

uint16_t sl_iperf_network_htons (uint16_t val)

iPerf host to network short

htons implementation for iPerf Returns

• uint16_t Converted value

sl_iperf_network_is_connected#

bool sl_iperf_network_is_connected (void )

Check network connection.

Checking the connection status. Returns

• true Network is connected

• false Network is NOT connected

sl_iperf_network_ntohl#

uint32_t sl_iperf_network_ntohl (uint32_t val)

iPerf network to host long

ntohl implementatino for iPerf Returns

• uint32_t Converted value

sl_iperf_network_ntohs#

uint16_t sl_iperf_network_ntohs (uint16_t val)

iPerf network to host short

ntohs implementation for iPerf Returns

• uint16_t Converted value

sl_iperf_nw_interface_init#

void sl_iperf_nw_interface_init (void )

Init iPerf Network Interface.

Initialize network interface

sl_iperf_set_socket_addr#

__STATIC_INLINE void sl_iperf_set_socket_addr (sl_iperf_socket_addr_t *const dest_addr, const void *const src_addr)

Set iPerf socket address.

Cerate a full copy of custom source address to the destination iperf address.

sl_iperf_set_socket_addr_family#

void sl_iperf_set_socket_addr_family (sl_iperf_socket_addr_t *const addr)

Set iPerf socket address family.

Set address family in socket address structure

sl_iperf_set_socket_addr_ip#

void sl_iperf_set_socket_addr_ip (sl_iperf_socket_addr_t *const addr, const void *const ip)

Set IP address bytes in iPerf address structure.

Setter function of IP address

sl_iperf_set_socket_addr_port#

void sl_iperf_set_socket_addr_port (sl_iperf_socket_addr_t *const addr, const uint16_t port)

Set port in iperf address structure.

Setter function of port property

sl_iperf_socket_accept#

int32_t sl_iperf_socket_accept (int32_t sockid, sl_iperf_socket_addr_t * addr)

Accept a connection on a socket.

It is used with connection-based socket types (TCP). It extracts the first connection request on the queue of pending connections for the listening socket. Returns

• On success, return with the socket id for accepted socket, on error -1 is returned.

sl_iperf_socket_bind#

int32_t sl_iperf_socket_bind (int32_t sockid, const sl_iperf_socket_addr_t * addr)

Bind a name to an iPerf socket.

Assigns the address specified by addr to the socket referred to by the socket id. It is normally necessary to assign a local address using bind() before a SOCK_STREAM socket may receive connections Returns

• On success, zero is returned. On error, -1 is returned

sl_iperf_socket_close#

int32_t sl_iperf_socket_close (int32_t sockid)

Close socket.

Close socket and remove from the socket handler storage Returns

• if any error occurred, return with -1, otherwise return with the socket id

sl_iperf_socket_connect#

int32_t sl_iperf_socket_connect (int32_t sockid, const sl_iperf_socket_addr_t * addr)

Initiate a connection on a socket.

Connects the socket referred to by the socketid to the address specified by addr. Returns

• If the connection or binding succeeds, zero is returned. On error, -1 is returned.

sl_iperf_socket_create#

int32_t sl_iperf_socket_create (sl_iperf_protocol_t protocol)

Create iPerf socket.

Create a socket by selected protocol and return with the socket ID Returns

• int32_t Socket ID

sl_iperf_socket_getsockopt#

int32_t sl_iperf_socket_getsockopt (int32_t sockid, int32_t level, int32_t optname, void * optval, size_t * optlen)

Get socket option.

The function gets socket option by optname, and copy option data to optval ptr Returns

• Return 0 on success, other wise -1

sl_iperf_socket_listen#

int32_t sl_iperf_socket_listen (int32_t sockid, int32_t backlog)

Listen for connections on an iPerf socket.

Marks the socket referred to by sockid as a passive socket, that is, as a socket that will be used to accept incoming connection requests using accept Returns

• On success, zero is returned. On error, -1 is returned

sl_iperf_socket_recv#

int32_t sl_iperf_socket_recv (int32_t sockid, void * buff, size_t len)

Receive a message from a socket.

It should be used for connection-oriented protocol (TCP) Returns

• return the number of bytes received, or -1 if an error occurred

sl_iperf_socket_recvfrom#

int32_t sl_iperf_socket_recvfrom (int32_t sockid, void * buf, uint32_t len, sl_iperf_socket_addr_t * src_addr)

Receive messages from a socket.

It can be used to receive data on a socket whether or not it is connection-oriented. Returns

• return the number of bytes received, or -1 if an error occurred

sl_iperf_socket_send#

int32_t sl_iperf_socket_send (int32_t sockid, const void * buff, size_t len)

Send a message on a socket,.

It is preferred with connection-oriented sockets (TCP). Returns

• On success, these calls return the number of bytes sent. On error, -1 is returned

sl_iperf_socket_sendto#

int32_t sl_iperf_socket_sendto (int32_t sockid, const void * buff, uint32_t len, const sl_iperf_socket_addr_t * dest_addr)

Send a message on a socket.

It is preferred in datagram mode (UDP). Returns

• On success, these calls return the number of bytes sent. On error, -1 is returned

sl_iperf_socket_setsockopt#

int32_t sl_iperf_socket_setsockopt (int32_t sockid, int32_t level, int32_t optname, const void * optval, size_t optlen)

Set socket option.

This function can set socket properties. There are some limitation in Wi-SUN domain: optlen and level args are not used. optname and optval are casted to the corresponding Wi-SUN types: sl_wisun_socket_option_t and sl_wisun_socket_option_data_t. sl_wisun_socket_option_data_t is a union type to include all of implemented Wi-SUN socket options Returns

• Return 0 on succes, other wise -1

sl_iperf_assert_sock_addr_len#

#define sl_iperf_assert_sock_addr_len

(__type)

Assert socket address length macro function.

SL_IPERF_IN6ADDR_SIZE#

#define SL_IPERF_IN6ADDR_SIZE

(16U)

Size definition of IPv6 address.

SL_IPERF_NW_API_ERROR#

#define SL_IPERF_NW_API_ERROR

(-1)

Define network api ERROR value.