IPWorks P2P 2020 Kotlin Edition

Questions / Feedback?

TURN Component

Properties   Methods   Events   Configuration Settings   Errors  

TBD.

Syntax

ipworksp2p.Turn

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.
AutoRefreshWhether the allocation should be refreshed automatically.
ChannelsA collection of currently open channels.
LifetimeThe lifetime of the allocation.
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.
PermissionsA collection of active permissions.
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.
RelayedIPThe IP address allocated on the server for the component.
RelayedPortThe port allocated on the server for the component.
SoftwareThe software string to report to the server when sending requests.
TimeoutA timeout for the component.
TTLThe number of seconds remaining until the allocation expires.
TURNPortThe port to connect to on the TURN server.
TURNServerThe TURN server to connect to.
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.

AllocateAllocates a relayed IP address and port on the server.
ConfigSets or retrieves a configuration setting.
CreateChannelCreates a new channel.
CreatePermissionCreates a new permission.
DoEventsProcesses events from the internal message queue.
RefreshAllocationRefreshes the allocation.
ResetReset the component.
SendChannelDataSends data to a peer using a given channel.
SendDataSends data to a peer using an indication.

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.

DataIn(TBD rename to DataIn.evt) Fires when data is received from a peer.
ErrorInformation about errors during data delivery.
ExpiredFires when an allocation, permission, or channel has expired.
LogFires once for each log message.
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.

AllocateAddressFamilyWhich address family to request an allocation for.
DontFragmentWhether the DONT-FRAGMENT attribute should be included in applicable requests.
DTLSSRTPCompatibilityWhether to restrict the channel number range for DTLS-SRTP collision avoidance.
EvenPortWhether an even port should be allocated.
EvenPortReserveNextWhether the server should also reserve the port immediately following the even port.
LogLevelSpecifies the level of detail that is logged.
ReservationTokenA token used to claim a reserved allocation.
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]