STUN Class
Properties Methods Events Configuration Settings Errors
TBD.
Syntax
ipworksp2p.Stun
Remarks
TBD.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Active | Enables or disables sending and receiving of data. |
Attributes | A collection of request attributes. |
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 the class binds. |
Password | The password to use for authentication. |
PublicIP | The public IP address returned by the server for the local host. |
PublicPort | The public port returned by the server for the local host. |
Realm | The realm to use for authentication. |
ResponseAttributes | A collection of response attributes. |
Software | The software string to report to the server when sending requests. |
STUNPort | The port to connect to on the STUN server. |
STUNServer | The STUN server to connect to. |
Timeout | A timeout for the class. |
TransactionId | The most recent transaction Id. |
UseClassicSTUN | Whether the class should use the classic STUN protocol. |
User | The user name to use for authentication. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
GetPublicAddress | Gets the local host's public IP address and port from the STUN server. |
Reset | Reset the class. |
SendIndication | Sends a STUN indication. |
SendRequest | Sends a STUN request. |
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.
Error | Information about errors during data delivery. |
Log | Fires once for each log message. |
MessageIn | Fires when a message is received. |
OAuth | Fires when received Third-Party Authorization attributes. |
ReadyToSend | Fired when the class is ready to send data. |
UnknownAttr | Fires when an unknown attribute is found in an incoming message. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AuthType | Overrides the authentication type used by the class. |
LogLevel | Specifies the level of detail that is logged. |
Nonce | The nonce value being used for authentication currently. |
RemoteSoftware | The software string reported by the server. |
CaptureIPPacketInfo | Used to capture the packet information. |
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 class 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 class 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. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |