| ppcstype1serverudpport | ||
|---|---|---|
 | Chapter 7. The PPCS Server for SBME Databases (PPSR) Component |  |
ppcstype1serverudpport
Description
A ppcstype1serverudpport object represents a UDP port, which a ppcstype1server object uses to provide PPCS support to clients using UDP.
Type Tags
None
Object Value
Properties
| Property | Type | Description |
|---|---|---|
| _ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. |
| __ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property. |
| next | ppcstype1serverudpport | Gives the next UDP port for the same ppcstype1server object. |
| server | ppcstype1server | Specifies the server to which this port belongs. |
| txfactor | integer | Contains the transmission factor used by the ppcstype1serverudpport object. This value is used to throttle the speed at which packets are sent. The value 0 means no throttling. If a value is specified that is too high to be useful, then the highest most meaningful value will be used. |
| type | type | Specifies the ppcstype1serverudpport type object. |
| udpport | integer | Specifies the number of the UDP port. |
Methods
remove()
Description
Removes a port from the ring of UDP ports for the server. The port is then available for use by other servers, although some operating systems will not make the port available until a platform specific time period has elapsed.
Prototype
ppcstype1serverudpportvar.remove ()
Parameters
None
settxfactor()
Description
Sets the transmission factor. This is used to moderate the speed at which the packets are transmitted. A factor of 0 means that the packets will be sent at the maximum speed (this may be too fast for Internet connectivity and result in difficulty reading data and excessive retries and timeouts).
Prototype
ppcstype1serverudpportvar.settxfactor (
integer txfactor
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| txfactor | None | integer | This is the factor to be used in slowing the sending of the packets. |