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_set_ip

Sets the IP address and network mask for an interface.

int xn_set_ip(int          iface_no, 
              const BYTE * ip_address, 
              const BYTE * ip_mask);

Parameters

iface_no

Interface number (returned by xn_interface_open, xn_interface_open_config, or xn_attach).

local_ip_address

Local IP address. Four bytes.

ip_mask

Local network mask (NULL=default). Four bytes.

return value

Returns 0 if successful, otherwise -1. 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
EBADIFACE	Invalid interface number (RTIP-32 specific).
EBADMASK	Parameter IP-MASK is invalid (RTIP-32 specific).
EIFACECLOSED	interface closed (RTIP-32 specific).
ENOTINITIALIZED	RTIP-32 has not been initialized (xn_rtip_init has not been called).
ERTFULL	routing table is full.

Before a network node can access IP services, it must have an IP address. There are five ways to establish the IP address. Call xn_bootp, xn_bootp_res, xn_rarp, or xn_dhcp to get your address from a bootp, RARP server, or DHCP. An IP address negotiation can be initiated if using PPP or xn_dhcp.

xn_bootp, xn_bootp_res, xn_rarp and xn_dhcp call this function when they have determined the interface's IP address and mask so this routine need not be called.

This function adds an entry to the routing table corresponding to the interface.

If parameter ip_mask is NULL, the default mask 255.255.255.0, is used. For SLIP and PPP connections, if the remote address is set (see xn_attach), the network mask is not used.

Either xn_interface_open or xn_attach must be called prior to calling this routine.

Left Extended RTIP-32 API

Function xn_rtip_restart

Down Function xn_tcp_is_connect