UDP Class

Properties   Methods   Events   Config Settings   Errors  

The UDP class 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.

Class Name

IPWorks_UDP

Procedural Interface

 ipworks_udp_open();
 ipworks_udp_close($res);
 ipworks_udp_register_callback($res, $id, $function);
 ipworks_udp_get_last_error($res);
 ipworks_udp_get_last_error_code($res);
 ipworks_udp_set($res, $id, $index, $value);
 ipworks_udp_get($res, $id, $index);
 ipworks_udp_do_activate($res);
 ipworks_udp_do_config($res, $configurationstring);
 ipworks_udp_do_deactivate($res);
 ipworks_udp_do_doevents($res);
 ipworks_udp_do_pausedata($res);
 ipworks_udp_do_processdata($res);
 ipworks_udp_do_reset($res);
 ipworks_udp_do_resolveremotehost($res);
 ipworks_udp_do_send($res, $text);
 ipworks_udp_do_sendbytes($res, $data);
 ipworks_udp_do_sendtext($res, $text);

Remarks

The interface of the class is similar to the interface of TCPClient, only much simpler. The class is activated/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. This is identical to assigning data to the DataToSend property. The destination is specified using the RemoteHost and RemotePort properties. Inbound data is received through the DataIn event.

If the UseConnection config setting is set to True, then a local association is created with the remote host. Otherwise, the class 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 (RemoteHost) to 255.255.255.255.

The operation of the class 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.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AcceptData Property (IPWorks_UDP Class)

This property enables or disables data reception (the DataIn event).

Object Oriented Interface

public function getAcceptData();


public function setAcceptData($value);

Procedural Interface

ipworks_udp_get($res, 1 );


ipworks_udp_set($res, 1, $value );

Default Value

true

Remarks

This property enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, reenables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

Active Property (IPWorks_UDP Class)

Indicates whether the class is active.

Object Oriented Interface

public function getActive();


public function setActive($value);

Procedural Interface

ipworks_udp_get($res, 2 );


ipworks_udp_set($res, 2, $value );

Default Value

false

Remarks

This property indicates whether the class is currently active and can send or receive data.

If UseConnection is set to True, then a local association (connection) to the remote host and port is also created.

Note: Use the Activate or Deactivate method to control whether the class is active.

This property is not available at design time.

Data Type

Boolean

DataToSend Property (IPWorks_UDP Class)

A string of data to be sent to the remote host. Write-only property.

Object Oriented Interface

public function setDataToSend($value);

Procedural Interface

ipworks_udp_set($res, 3, $value );

Default Value

''

Remarks

Assigning a string to the DataToSend property makes the class send the string to the remote host. The Send method provides similar functionality.

Attempts to send the string assigned to DataToSend as a complete message. If system buffers are full, or the message cannot be delivered for any other reason, an error is fired, and no portion of the message is sent. This is different from TCP where portions of the messages can be sent. UDP sends either a complete message or nothing at all.

If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, DataToSend fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again.

Example (Send Data)

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.DataToSend = "Hello!"

This property is write-only and not available at design time.

Data Type

Binary String

DontRoute Property (IPWorks_UDP Class)

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

Object Oriented Interface

public function getDontRoute();


public function setDontRoute($value);

Procedural Interface

ipworks_udp_get($res, 4 );


ipworks_udp_set($res, 4, $value );

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.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (IPWorks_UDP Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

ipworks_udp_get($res, 5 );


ipworks_udp_set($res, 5, $value );

Default Value

''

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

LocalPort Property (IPWorks_UDP Class)

The UDP port in the local host where UDP binds.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworks_udp_get($res, 6 );


ipworks_udp_set($res, 6, $value );

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

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

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

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

Data Type

Integer

RemoteHost Property (IPWorks_UDP Class)

The address of the remote host. Domain names are resolved to IP addresses.

Object Oriented Interface

public function getRemoteHost();


public function setRemoteHost($value);

Procedural Interface

ipworks_udp_get($res, 7 );


ipworks_udp_set($res, 7, $value );

Default Value

''

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host.

If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.

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

If UseConnection is set to True, the RemoteHost must be set before the class is activated (Active is set to True).

Data Type

String

RemotePort Property (IPWorks_UDP Class)

The UDP port in the remote host.

Object Oriented Interface

public function getRemotePort();


public function setRemotePort($value);

Procedural Interface

ipworks_udp_get($res, 8 );


ipworks_udp_set($res, 8, $value );

Default Value

0

Remarks

The RemotePort is the UDP port on the RemoteHost to send UDP datagrams to.

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

If UseConnection is set to True, the RemotePort must be set before the class is activated (Active is set to True).

Data Type

Integer

TimeToLive Property (IPWorks_UDP Class)

The maximum number of subnets that a datagram can traverse.

Object Oriented Interface

public function getTimeToLive();


public function setTimeToLive($value);

Procedural Interface

ipworks_udp_get($res, 9 );


ipworks_udp_set($res, 9, $value );

Default Value

0

Remarks

The default value for this property is 0, which tells the class to use the default TTL value of the underlying TCP/IP subsystem. Depending on the application, you can specify a value between 1 and 255.

Data Type

Integer

Activate Method (IPWorks_UDP Class)

Enables sending and receiving of data.

Object Oriented Interface

public function doActivate();

Procedural Interface

ipworks_udp_do_activate($res);

Remarks

This method enables sending and receiving of data. When called the class will create a communication endpoint (socket) which can be used for sending and receiving UDP messages. This method must be called before using the class 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 (IPWorks_UDP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_udp_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (IPWorks_UDP Class)

Disables sending and receive of data.

Object Oriented Interface

public function doDeactivate();

Procedural Interface

ipworks_udp_do_deactivate($res);

Remarks

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

DoEvents Method (IPWorks_UDP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_udp_do_doevents($res);

Remarks

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

PauseData Method (IPWorks_UDP Class)

This method pauses data reception.

Object Oriented Interface

public function doPauseData();

Procedural Interface

ipworks_udp_do_pausedata($res);

Remarks

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

ProcessData Method (IPWorks_UDP Class)

This method reenables data reception after a call to PauseData .

Object Oriented Interface

public function doProcessData();

Procedural Interface

ipworks_udp_do_processdata($res);

Remarks

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

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

Reset Method (IPWorks_UDP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_udp_do_reset($res);

Remarks

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

ResolveRemoteHost Method (IPWorks_UDP Class)

Resolves the hostname in RemoteHost to an IP address.

Object Oriented Interface

public function doResolveRemoteHost();

Procedural Interface

ipworks_udp_do_resolveremotehost($res);

Remarks

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

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

Send Method (IPWorks_UDP Class)

Send data to the remote host.

Object Oriented Interface

public function doSend($text);

Procedural Interface

ipworks_udp_do_send($res, $text);

Remarks

Calling this method is equivalent to setting the DataToSend property to Text.

Example (Send Data)

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

SendBytes Method (IPWorks_UDP Class)

Send data to the remote host.

Object Oriented Interface

public function doSendBytes($data);

Procedural Interface

ipworks_udp_do_sendbytes($res, $data);

Remarks

Calling this method is equivalent to call SendBytes/SendText method.

Example (Send Data)

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

SendText Method (IPWorks_UDP Class)

Send data to the remote host.

Object Oriented Interface

public function doSendText($text);

Procedural Interface

ipworks_udp_do_sendtext($res, $text);

Remarks

Calling this method is equivalent to call SendBytes/SendText method.

Example (Send Data)

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

DataIn Event (IPWorks_UDP Class)

Fired when data is received.

Object Oriented Interface

public function fireDataIn($param);

Procedural Interface

ipworks_udp_register_callback($res, 1, array($this, 'fireDataIn'));

Parameter List

 'datagram'
 'sourceaddress'
 'sourceport'

Remarks

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

Datagram contains the packet as sent by the remote host.

SourceAddress contains the IP number (Internet address) of the remote host, and SourcePort 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.

Error Event (IPWorks_UDP Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_udp_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

ReadyToSend Event (IPWorks_UDP Class)

Fired when the class is ready to send data.

Object Oriented Interface

public function fireReadyToSend($param);

Procedural Interface

ipworks_udp_register_callback($res, 3, array($this, 'fireReadyToSend'));

Parameter List

Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend.

Config Settings (UDP Class)

The class 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 class, access to these internal properties is provided through the Config method.

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UDP Class)

UDP Errors

	104   UDP is already Active.
	106   You cannot change the LocalPort while the class is Active.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	109   The class must be Active for this operation.
	112   Cannot change MaxPacketSize while the class is Active.
	113   Cannot change ShareLocalPort option while the class is Active.
	114   Cannot change RemoteHost when UseConnection is set and the class Active.
	115   Cannot change RemotePort when UseConnection is set and the class is Active.
	116   RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
	117   Cannot change UseConnection while the class is Active.
	118   Message can't be longer than MaxPacketSize.
	119   Message too short.
	434   Unable to convert string to selected CodePage

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).