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_ping

Send a ping message to a host and wait for it to reply.

int xn_ping(int                  sequence, 
            int                  len, 
            int                  ttl, 
            BYTE               * host, 
            int                  route_type, 
            struct _route_info * route_info, 
            unsigned int         wait_count, 
            long               * elapsed_msec);

Parameters

sequence

Integer sent to the host. The reply should contain this number.

len

Number of bytes to send in the packet (helps measure throughput).

ttl

Time-to-live to use for IP header in seconds. If 0, the default value will be used.

host

IP address of the host in network byte order.

route_type

IP options (0, SO_RECORD_ROUTE_OPTION, SO_LOOSE_ROUTE_OPTION, SO_STRICT_ROUTE_OPTION). See xn_ip_set_option.

route_info

Specifies routing information, i.e. addresses for LOOSE and STRICT routes and size for all routing options; also returns routing information for all routing options. See xn_ip_set_option. This parameter may be NULL.

wait_count

Number of timer ticks to wait for a reply.

elapsed_msec

Elapsed time in milliseconds after which a reply was received. This parameter may be NULL.

return value

Returns 0 if the specified host replied with the correct sequence number within wait_count ticks, otherwise SOCKET_ERROR. If an error occurred, call xn_getlasterror and xn_geterror_string to return the error value. Section Error Codes further describes each error.

Possible values for this function are:

Value	Meaning
EADDRNOTAVAIL	Endpoint address not available.
EARPFULL	ARP table is full (RTIP-32 specific).
EBADIFACE	Invalid interface number (RTIP-32 specific).
EBADRESP	Invalid ping response (RTIP-32 specific).
EIFACECLOSED	Interface closed (RTIP-32 specific).
ENETDOWN	Network is down, i.e. send failed.
ENOPKTS	Out of DCUs, i.e. packets.
ENOTINITIALIZED	RTIP-32 has not been initialized (xn_rtip_init has not been called).
EOUTPUTFULL	Output list full (RTIP-32 Specific).
ETIMEDOUT	Operation timed out.

This routine uses the ICMP layer to send a ping message to another network node. If the other node is up, it will echo the packet back to this node. The parameter route_type is used to set up one IP option in the ping request. If route_type is 0, the ping request will not contain any options.

Left Extended RTIP-32 API

Function xn_ip_set_option

Down Function xn_pkt_data_max