On Time RTOS-32 Documentation

RTIP-32 Programming Manual

RTIP-32 Reference Manual

RTIP-32 Configuration

Simplified Networking API

Extended RTIP-32 API

Function vf_init

Function xn_add_dns_server

Function xn_add_host_table_entry

Function xn_clear_host_cache

Function xn_delete_host_table_entry

Function xn_get_domain_name

Function xn_has_dns

Function xn_set_domain_name

Function xn_set_server_list

Function xn_name2ip_addr

Function xn_abort

Function xn_arp_send

Function xn_attach

Function xn_bootp_res

Function xn_bootp

Function xn_debug_error

Function xn_getlasterror

Function xn_geterror_string

Function xn_interface_close

Function xn_interface_info

Function xn_interface_mcast

Function xn_interface_open

Function xn_interface_open_config

Function xn_interface_opt

Function xn_interface_ethernet_statistics

Function xn_interface_statistics

Function xn_ip_set_option

Function xn_ping

Function xn_pkt_data_max

Function xn_rarp

Function xn_rt_add

Function xn_rt_cycle_gw

Function xn_rt_del

Function xn_rt_replace

Function xn_rtip_exit

Function xn_rtip_init

Function xn_rtip_restart

Function xn_set_ip

Function xn_tcp_is_connect

Function xn_tcp_is_read

Function xn_tcp_is_write

Function xn_wait_tcp_output

Function xn_autoanswer

Function xn_autologin

Function xn_hangup

Function xn_scriptlogin

Function xn_autoip

Function xn_ioacc_init

Function xn_nat_init

Function xn_arp_add

Function xn_arp_del

Function xn_arp_remote

Function xn_arp_cache_lookup

Function xn_send_ethernet_frame

Function xn_callbacks

Function cb_wr_screen_string_fnc

Function cb_rs232_connection_lost_fnc

Function cb_error_report_fnc

Function cb_raw_mode_in_char_fnc

Function cb_autoip_new_ip_fnc

Function cb_autoip_no_ip_fnc

Function cb_packetin_isr

Function cb_packetin_task

Function cb_packetout

Previous

Next

Function xn_ip_set_option

Change an IP option associated with a UDP or TCP socket.

int xn_ip_set_option(SOCKET       socket, 
                     int          option_name, 
                     const char * option_value, 
                     int          optionlen);

Parameters

socket

Socket returned by socket.

option name

Option to set, see below for all supported values.

option_value

Pointer to buffer containing additional values for the option.

optionlen

Length of *option_value.

return value

Returns 0 if option set successfully, otherwise SOCKET_ERROR. If an error occurred, call xn_getlasterror and xn_geterror_string to return the error value. Error Codes further describes each error.

The supported option_names are

Value	Meaning
SO_TIMESTAMP_OPTION	See setsockopt.
SO_LOOSE_ROUTE_OPTION	Set loose routing. The IP address of the next router can be one or more routers away (multiple hops). *option_value is of type struct route_info.
SO_RECORD_ROUTE_OPTION	*option_value is of type int and specifies the maximum number of routes to record.
SO_STRICT_ROUTE_OPTION	Set strict routing in which the next router must be a neighboring router (single hop). *option_value is of type struct route_info.

typedef struct _route_info 
{ 
   int    route_len;        // number of bytes pointed to by route_addresses 
   BYTE * route_addresses;  // list of routes 
} ROUTE_INFO;

When xn_ip_set_option is called, the route_addresses are not copied into RTIP-32 data area but the address is saved. Therefore, the route_addresses should not be changed by the application while the routing option is on.

Only one route IP option can be in effect; for example, if the LOOSE route option is turned on and xn_ip_set_option is called to turn on RECORD route, then LOOSE route will be turned off.

Please note that many routers no longer support route options. Setting any route option may cause them to discard all packets with such options set.

Left Extended RTIP-32 API

Function xn_interface_statistics

Down Function xn_ping