Struct ipworks::UDP

Properties   Methods   Events   Config Settings   Errors  

The User Datagram Protocol (UDP) struct is used to facilitate UDP (datagram) communications. It can act both as a client and a server and communicate with any number of hosts simultaneously, as well as generate and receive broadcast packets.

Syntax

ipworks::UDP

Remarks

The interface of the struct is similar to the interface of TCPClient, only much simpler. The struct is activated or deactivated through the active property. This property enables or disables sends or receives. The data can be sent in the same way as TCPClient, using the send method and specifying the text to send. The destination is specified using the remote_host and remote_port properties. Inbound data are received through the on_data_in event.

If the UseConnection configuration setting is set to True, then a local association is created with the remote host. Otherwise, the struct can receive datagrams (packets) from any host, and send datagrams to any host. Packets can be broadcast on the local net by setting the destination (remote_host) to 255.255.255.255.

The operation of the struct is almost completely asynchronous. All calls, except the ones that deal with domain name resolution, operate through Windows messages (no blocking calls). The gain in performance is considerable when compared to using blocking calls.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the UDP struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of UDP when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

accept_data property (UDP Struct)

This property indicates whether data reception is currently enabled.

Syntax

fn accept_data(&self ) -> Result<bool, IPWorksError> 

Default Value

true

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled and the on_data_in event will not fire. Use the pause_data and process_data methods to pause and resume data reception.

This property is read-only.

Data Type

bool

active property (UDP Struct)

This property indicates whether the struct is active.

Syntax

fn active(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether the struct is currently active and can send or receive data. Use the activate and deactivate methods to control whether the struct is active.

This property is read-only.

Data Type

bool

dont_route property (UDP Struct)

If this property is set to True, it forces the socket to send data directly to the interface (no routing).

Syntax

fn dont_route(&self ) -> Result<bool, IPWorksError> 
fn set_dont_route(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

If this property is set to True, it forces the socket to send data directly to the interface (no routing). Normally, IP sockets send packets of data through routers and gateways until they reach the final destination. If this property is set to True, then data will be delivered on the local subnet only.

Data Type

bool

local_host property (UDP Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (UDP Struct)

This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

The local_port property must be set before UDP is activated (active is set to True). This instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the local_port property after the connection is established.

local_port cannot be changed once the struct is active. Any attempt to set the local_port property when the struct is active will generate an error.

The local_port property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

i32

remote_host property (UDP Struct)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

fn remote_host(&self ) -> Result<String, IPWorksError> 
fn set_remote_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_remote_host_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The remote_host property specifies the IP address (IP number in dotted internet format) or domain name of the remote host.

If remote_host is set to 255.255.255.255, the struct broadcasts data on the local subnet.

If the remote_host property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the remote_host property is set to the corresponding address. If the search is not successful, an error is returned.

If UseConnection is set to True, the remote_host must be set before the struct is activated (active is set to True).

Data Type

String

remote_port property (UDP Struct)

This property specifies the User Datagram Protocol (UDP) port in the remote host.

Syntax

fn remote_port(&self ) -> Result<i32, IPWorksError> 
fn set_remote_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

The remote_port is the UDP port on the remote_host to send UDP datagrams to.

A valid port number (a value between 1 and 65535) is required.

If UseConnection is set to True, the remote_port must be set before the struct is activated (active is set to True).

Data Type

i32

time_to_live property (UDP Struct)

This property specifies the maximum number of subnets that a datagram can traverse.

Syntax

fn time_to_live(&self ) -> Result<i32, IPWorksError> 
fn set_time_to_live(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

The default value for this property is 0, which tells the struct to use the default time-to-live (TTL) value of the underlying Transmission Control Protocol (TCP)/IP subsystem. Depending on the application, you can specify a value between 1 and 255.

Data Type

i32

activate method (UDP Struct)

This method enables sending and receiving of data.

Syntax

fn activate(&self) -> Result<(), IPWorksError>

Remarks

This method enables sending and receiving of data. When called, the struct will create a communication endpoint (socket) that can be used for sending and receiving User Datagram Protocol (UDP) messages. This method must be called before using the struct to send and receive data.

If the UseConnection configuration setting is set to true, then a local association (connection) to the remote host is also created.

config method (UDP Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

deactivate method (UDP Struct)

This method disables sending and receive of data.

Syntax

fn deactivate(&self) -> Result<(), IPWorksError>

Remarks

This method disables sending and receiving of data. When called, the struct will destroy the existing socket and disable data communications.

do_events method (UDP Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

pause_data method (UDP Struct)

This method pauses data reception.

Syntax

fn pause_data(&self) -> Result<(), IPWorksError>

Remarks

This method pauses data reception when called. While data reception is paused, the on_data_in event will not fire. Call process_data to reenable data reception.

process_data method (UDP Struct)

This method reenables data reception after a call to PauseData .

Syntax

fn process_data(&self) -> Result<(), IPWorksError>

Remarks

This method reenables data reception after a previous call to pause_data. When pause_data is called, the on_data_in event will not fire. To reenable data reception and allow on_data_in to fire, call this method.

NOTE: This method is used only after previously calling pause_data. It does not need to be called to process incoming data by default.

reset method (UDP Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksError>

Remarks

This method will reset the struct's properties to their default values.

resolve_remote_host method (UDP Struct)

This method resolves the hostname in RemoteHost to an IP address.

Syntax

fn resolve_remote_host(&self) -> Result<(), IPWorksError>

Remarks

This method resolves the hostname specified by remote_host to an IP address. The resolved value is available in the remote_host property after this method returns.

In most cases, calling this method is not necessary; the struct will resolve the hostname automatically when needed. If DelayHostResolution is true, this method may be called to manually resolve remote_host, if desired.

send method (UDP Struct)

This method sends binary data to the remote host.

Syntax

fn send(&self, text : &[u8]) -> Result<(), IPWorksError>

Remarks

This method sends the specified binary data to the remote host. To send text, use the send_text method instead.

Example. Send Data:

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.SendText("Hello!")

send_bytes method (UDP Struct)

This method sends binary data to the remote host.

Syntax

fn send_bytes(&self, data : &[u8]) -> Result<(), IPWorksError>

Remarks

This method sends the specified binary data to the remote host. To send text, use the send_text method instead.

Example. Send Data:

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.SendText("Hello!")

send_text method (UDP Struct)

This method sends text to the remote host.

Syntax

fn send_text(&self, text : &str) -> Result<(), IPWorksError>

Remarks

This method sends the specified text to the remote host. To send binary data, use the send_bytes method instead.

Example. Send Data:

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.SendText("Hello!")

on_data_in event (UDP Struct)

This event is fired when data are received.

Syntax

// UDPDataInEventArgs carries the UDP DataIn event's parameters.
pub struct UDPDataInEventArgs {
  fn datagram(&self) -> &[u8]
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
}

// UDPDataInEvent defines the signature of the UDP DataIn event's handler function.
pub trait UDPDataInEvent {
  fn on_data_in(&self, sender : UDP, e : &mut UDPDataInEventArgs);
}

impl <'a> UDP<'a> {
  pub fn on_data_in(&self) -> &'a dyn UDPDataInEvent;
  pub fn set_on_data_in(&mut self, value : &'a dyn UDPDataInEvent);
  ...
}

Remarks

The on_data_in event is fired every time a new datagram is received.

datagram contains the packet as sent by the remote host.

source_address contains the IP number (Internet address) of the remote host, and source_port contains the port from which the packet originated.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

on_error event (UDP Struct)

Fired when information is available about errors during data delivery.

Syntax

// UDPErrorEventArgs carries the UDP Error event's parameters.
pub struct UDPErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// UDPErrorEvent defines the signature of the UDP Error event's handler function.
pub trait UDPErrorEvent {
  fn on_error(&self, sender : UDP, e : &mut UDPErrorEventArgs);
}

impl <'a> UDP<'a> {
  pub fn on_error(&self) -> &'a dyn UDPErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn UDPErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_ready_to_send event (UDP Struct)

This event is fired when the struct is ready to send data.

Syntax

// UDPReadyToSendEventArgs carries the UDP ReadyToSend event's parameters.
pub struct UDPReadyToSendEventArgs {
}

// UDPReadyToSendEvent defines the signature of the UDP ReadyToSend event's handler function.
pub trait UDPReadyToSendEvent {
  fn on_ready_to_send(&self, sender : UDP, e : &mut UDPReadyToSendEventArgs);
}

impl <'a> UDP<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn UDPReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn UDPReadyToSendEvent);
  ...
}

Remarks

The on_ready_to_send event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed send.

Config Settings (UDP Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UDP Struct)

UDP Errors

SSL Errors

TCP/IP Errors