Network function


Functions

int SAL_start_network ()
 Initialise the network.
int SAL_stop_network ()
 Stop the network.
int addUdpInputSocket (Uint16 portNr)
 Add udp socket.
int addUdpOutputSocket (Uint16 portNr)
 Add udp socket.
int sendUdpMessage (const char *message, Uint16 mesLen, IPaddress *addresses, Uint8 numIp, UDPsocket socket)
 Add udp socket.
int SAL_network_listener_thread (void *unused)
 Listen for udp messages.
int salSetNetworkHandler (int(*network_handler)(char *message, IPaddress *address))
 Connect network handler with network listener.

Detailed Description

The SAL network system makes it posible the create an udp "connection" with another computer.

Function Documentation

int addUdpInputSocket ( Uint16  portNr  ) 

Add udp socket.

Parameters:
portNr Port Nr.
Add udp input socket to network manager

Definition at line 85 of file SAL_network.cpp.

References salList< SAL_list_entry >::append(), SAL_setting::common, SAL_intern::event, salList< SAL_list_entry >::getSize(), SAL_structure::internal, SAL_int_event::last_network_listener, SAL_set_common::max_con_network_listener, SAL_int_event::network_listeners, SAL_network_listener_thread(), salError(), SAL_structure::setting, SAL_network_listener::sockets, SAL_network_listener::socketSet, and SAL_network_listener::thread.

int addUdpOutputSocket ( Uint16  portNr  ) 

Add udp socket.

Parameters:
portNr Port Nr.
Add udp output socket to network manager

Definition at line 124 of file SAL_network.cpp.

References salList< SAL_list_entry >::append(), SAL_intern::event, SAL_structure::internal, salError(), and SAL_int_event::socketsOut.

int SAL_network_listener_thread ( void *  unused  ) 

Listen for udp messages.

Parameters:
unused Not used.
Note:
Defined internaly.
Listens at a defined port for udp messages.

Definition at line 194 of file SAL_network.cpp.

References SAL_int_checks::alive, SAL_intern::checks, SAL_setting::common, SAL_intern::event, salList< SAL_list_entry >::getLoopEntry(), salList< SAL_list_entry >::inLoop(), SAL_structure::internal, SAL_int_event::last_network_listener, SAL_set_common::network_time_out_function, SAL_set_common::network_time_out_time, salError(), salList< SAL_list_entry >::setLoopBegin(), SAL_structure::setting, SAL_network_listener::sockets, and SAL_network_listener::socketSet.

Referenced by addUdpInputSocket().

int SAL_start_network (  ) 

Initialise the network.

Note:
Started by SAL function

Defined internaly.

Start the network manager.

Definition at line 41 of file SAL_network.cpp.

References salError().

Referenced by SAL().

int SAL_stop_network (  ) 

Stop the network.

Note:
Started by SAL_quit function when application terminates.

Defined internaly.

Stop the network manager.

Definition at line 59 of file SAL_network.cpp.

References SAL_intern::event, salList< SAL_list_entry >::getLoopEntry(), salList< SAL_list_entry >::inLoop(), SAL_structure::internal, SAL_int_event::network_listeners, salList< SAL_list_entry >::setLoopBegin(), SAL_network_listener::sockets, SAL_network_listener::socketSet, and SAL_network_listener::thread.

Referenced by SAL_quit().

int salSetNetworkHandler ( int(*)(char *message, IPaddress *address)  network_handler  ) 

Connect network handler with network listener.

Parameters:
network_handler Programmer defined user handler function
Connects a programmer defined network handler function with a network listener.

Definition at line 275 of file SAL_network.cpp.

References SAL_intern::event, SAL_network_handler::handler, SAL_structure::internal, and SAL_int_event::network_handler.

int sendUdpMessage ( const char *  message,
Uint16  mesLen,
IPaddress *  addresses,
Uint8  numIp,
UDPsocket  socket 
)

Add udp socket.

Parameters:
message Message that is send to target.
mesLen Length of message.
addresses Addresses that receave the message.
numIp Number of ip addresses in addresses array.
socket Socket that sends udp packet
Add udp input socket to network manager

Definition at line 153 of file SAL_network.cpp.

References salError().