IPWorks P2P 2020 Kotlin Edition

Questions / Feedback?

STUN Component

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 component with short descriptions. Click on the links for further details.

ActiveEnables or disables sending and receiving of data.
AttributesA collection of request attributes.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe UDP port in the local host where the component binds.
PasswordThe password to use for authentication.
PublicIPThe public IP address returned by the server for the local host.
PublicPortThe public port returned by the server for the local host.
RealmThe realm to use for authentication.
ResponseAttributesA collection of response attributes.
SoftwareThe software string to report to the server when sending requests.
STUNPortThe port to connect to on the STUN server.
STUNServerThe STUN server to connect to.
TimeoutA timeout for the component.
TransactionIdThe most recent transaction Id.
UseClassicSTUNWhether the component should use the classic STUN protocol.
UserThe user name to use for authentication.

Method List


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

ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetPublicAddressGets the local host's public IP address and port from the STUN server.
ResetReset the component.
SendIndicationSends a STUN indication.
SendRequestSends a STUN request.

Event List


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

ErrorInformation about errors during data delivery.
LogFires once for each log message.
MessageInFires when a message is received.
OAuthFires when received Third-Party Authorization attributes.
ReadyToSendFired when the component is ready to send data.
UnknownAttrFires when an unknown attribute is found in an incoming message.

Configuration Settings


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

AuthTypeOverrides the authentication type used by the component.
LogLevelSpecifies the level of detail that is logged.
NonceThe nonce value being used for authentication currently.
RemoteSoftwareThe software string reported by the server.
CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the component to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the component are daemon threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks P2P 2020 Kotlin Edition - Version 20.0 [Build 7941]