UDPPort Module
Properties Methods Events Configuration Settings Errors
The UDPPort module 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.Udpport
Remarks
The interface of the class is similar to the interface of IPPort, 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 IPPort, 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 module with short descriptions. Click on the links for further details.
AcceptData | Enables or disables data reception (the DataIn event). |
Active | Enables or disables sending and receiving of data. |
DontRoute | If set to True, it forces the socket to send data directly to interface (no routing). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The UDP port in the local host where UDPPort binds. |
RemoteHost | The address of the remote host. Domain names are resolved to IP addresses. |
RemotePort | The UDP port in the remote host. |
TimeToLive | The maximum number of subnets that a datagram can traverse. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
Activate | Enables sending and receiving of data. |
Config | Sets or retrieves a configuration setting. |
Deactivate | Disables sending and receive of data. |
DoEvents | Processes events from the internal message queue. |
PauseData | Pauses data reception. |
ProcessData | Re-enables data reception after a call to PauseData . |
Reset | Reset the module. |
ResolveRemoteHost | Resolves the hostname in RemoteHost to an IP address. |
Send | Send data to the remote host. |
SendBytes | Send data to the remote host. |
SendText | Send data to the remote host. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
DataIn | Fired when data is received. |
Error | Information about errors during data delivery. |
ReadyToSend | Fired when the module is ready to send data. |
Configuration Settings
The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the module binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the module to be active on the same local port. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the module whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (UDPPort Module)
Enables or disables data reception (the DataIn event).
Syntax
public var acceptData: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=acceptData,setter=setAcceptData:) BOOL acceptData; - (BOOL)acceptData; - (void)setAcceptData :(BOOL)newAcceptData;
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, re-enables data reception.
Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.
Active Property (UDPPort Module)
Enables or disables sending and receiving of data.
Syntax
public var active: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=active,setter=setActive:) BOOL active; - (BOOL)active; - (void)setActive :(BOOL)newActive;
Default Value
False
Remarks
Setting the Active property to True makes the class create a communication endpoint (socket) which can be used for sending and receiving UDP datagrams. Setting it to False destroys the socket and disables data communications.
If UseConnection is set to True, then a local association (connection) to the remote host and port is also created.
Note: It is recommended to use the Activate or Deactivate method instead of setting this property.
DontRoute Property (UDPPort Module)
If set to True, it forces the socket to send data directly to interface (no routing).
Syntax
public var dontRoute: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=dontRoute,setter=setDontRoute:) BOOL dontRoute; - (BOOL)dontRoute; - (void)setDontRoute :(BOOL)newDontRoute;
Default Value
False
Remarks
If this property is set to True, it forces the socket to send data directly to 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.
LocalHost Property (UDPPort Module)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public var localHost: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost; - (NSString*)localHost; - (void)setLocalHost :(NSString*)newLocalHost;
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.
LocalPort Property (UDPPort Module)
The UDP port in the local host where UDPPort binds.
Syntax
public var localPort: Int32 {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort; - (int)localPort; - (void)setLocalPort :(int)newLocalPort;
Default Value
0
Remarks
The LocalPort property must be set before UDPPort 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.
RemoteHost Property (UDPPort Module)
The address of the remote host. Domain names are resolved to IP addresses.
Syntax
public var remoteHost: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=remoteHost,setter=setRemoteHost:) NSString* remoteHost; - (NSString*)remoteHost; - (void)setRemoteHost :(NSString*)newRemoteHost;
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).
RemotePort Property (UDPPort Module)
The UDP port in the remote host.
Syntax
public var remotePort: Int32 {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=remotePort,setter=setRemotePort:) int remotePort; - (int)remotePort; - (void)setRemotePort :(int)newRemotePort;
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).
TimeToLive Property (UDPPort Module)
The maximum number of subnets that a datagram can traverse.
Syntax
public var timeToLive: Int32 {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=timeToLive,setter=setTimeToLive:) int timeToLive; - (int)timeToLive; - (void)setTimeToLive :(int)newTimeToLive;
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.
Activate Method (UDPPort Module)
Enables sending and receiving of data.
Syntax
public func activate() throws -> Void
- (void)activate;
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 , then a local association (connection) to the remote host is also created.
Config Method (UDPPort Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)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 (UDPPort Module)
Disables sending and receive of data.
Syntax
public func deactivate() throws -> Void
- (void)deactivate;
Remarks
This method disables sending and receiving of data. When called the class will destroy the existing socket and disable data communications.
DoEvents Method (UDPPort Module)
Processes events from the internal message queue.
Syntax
public func doEvents() throws -> Void
- (void)doEvents;
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 (UDPPort Module)
Pauses data reception.
Syntax
public func pauseData() throws -> Void
- (void)pauseData;
Remarks
This method pauses data reception when called. While data reception is paused the DataIn event will not fire. Call ProcessData to re-enable data reception.
ProcessData Method (UDPPort Module)
Re-enables data reception after a call to PauseData .
Syntax
public func processData() throws -> Void
- (void)processData;
Remarks
This method re-enables data reception after a previous call to PauseData. When PauseData is called the DataIn event will not fire. To re-enable data reception and allow DataIn to fire call this method.
Note: This method is only used after previously calling PauseData. It does not need to be called to process incoming data by default.
Reset Method (UDPPort Module)
Reset the component.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
This method will reset the class's properties to their default values.
ResolveRemoteHost Method (UDPPort Module)
Resolves the hostname in RemoteHost to an IP address.
Syntax
public func resolveRemoteHost() throws -> Void
- (void)resolveRemoteHost;
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 this method may be called to manually resolve RemoteHost if desired.
Send Method (UDPPort Module)
Send data to the remote host.
Syntax
Remarks
Calling this method is equivalent to setting the DataToSend property to Text.
Example (Send Data)
UDPPortControl.LocalPort = 8765
UDPPortControl.RemotePort = 8765
UDPPortControl.RemoteHost = "HostNameOrIPAddress"
UDPPortControl.Active = True
UDPPortControl.Send("Hello!")
SendBytes Method (UDPPort Module)
Send data to the remote host.
Syntax
Remarks
Calling this method is equivalent to call SendBytes/SendText method.
Example (Send Data)
UDPPortControl.LocalPort = 8765
UDPPortControl.RemotePort = 8765
UDPPortControl.RemoteHost = "HostNameOrIPAddress"
UDPPortControl.Active = True
UDPPortControl.Send("Hello!")
SendText Method (UDPPort Module)
Send data to the remote host.
Syntax
Remarks
Calling this method is equivalent to call SendBytes/SendText method.
Example (Send Data)
UDPPortControl.LocalPort = 8765
UDPPortControl.RemotePort = 8765
UDPPortControl.RemoteHost = "HostNameOrIPAddress"
UDPPortControl.Active = True
UDPPortControl.Send("Hello!")
DataIn Event (UDPPort Module)
Fired when data is received.
Syntax
- (void)onDataIn:(NSData*)datagram :(NSString*)sourceAddress :(int)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 that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.
Error Event (UDPPort Module)
Information about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
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 (UDPPort Module)
Fired when the component is ready to send data.
Syntax
func onReadyToSend()
- (void)onReadyToSend;
Remarks
The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend.
Configuration Settings (UDPPort Module)
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.UDPPort Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CaptureIPPacketInfo:
Used to capture the packet information.If this is set to true, the component will capture the IP packet information.
The default value for this setting is False. Note: This setting is only available in Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If the class will resolve the hostname and the IP address will be present in the RemoteHost property.
If , the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.
The default value is . |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DestinationAddress:
Used to get the destination address from the packet information.If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.
Note: This setting is only available in Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DontFragment: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting 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 setting 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). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxPacketSize: The maximum length of the packets that can be received.This setting specifies the maximum size of the datagrams that the class will accept without truncation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QOSDSCPValue:
Used to specify an arbitrary QOS/DSCP setting (optional).UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.
Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QOSTrafficType:
Used to specify QOS/DSCP settings (optional).UseConnection must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).
Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above. Note: QOSTrafficType must be set before setting Active to true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShareLocalPort:
If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through
the Active property or it will have no effect.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseConnection:
Determines whether to use a connected socket.UseConnection specifies whether the class
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the class will send and receive data
only to and from the specified destination.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API. |
Trappable Errors (UDPPort Module)
UDPPort Errors
104 UDPPort 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). |