Compare commits

..

No commits in common. "master" and "stable/jitsi-meet_3547" have entirely different histories.

174 changed files with 8115 additions and 6007 deletions

View File

@ -1,17 +0,0 @@
[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
[pom.xml]
indent_size = 2
indent_style = space
max_line_length = 120
[*.{kt,kts}]
max_line_length = 120
ktlint_code_style = intellij_idea
# I find trailing commas annoying
ktlint_standard_trailing-comma-on-call-site = disabled
ktlint_standard_trailing-comma-on-declaration-site = disabled

View File

@ -1,82 +0,0 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Java CI with Maven
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
env:
# Java version to use for the release
RELEASE_JAVA_VERSION: 11
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
java: [ 11, 17 ]
name: Java ${{ matrix.java }}
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up JDK ${{ matrix.java }}
uses: actions/setup-java@v3
with:
distribution: temurin
java-version: ${{ matrix.java }}
cache: maven
- name: Build and test with Maven
run: mvn -B -Dgpg.skip -Drelease=true -Pcoverage verify
- name: Upload coverage report
if: matrix.java == env.RELEASE_JAVA_VERSION
uses: codecov/codecov-action@v2
release:
if: github.ref == 'refs/heads/master'
needs: test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up JDK
uses: actions/setup-java@v3
with:
distribution: temurin
java-version: ${{ env.RELEASE_JAVA_VERSION }}
cache: maven
server-id: ossrh
server-username: SONATYPE_USER
server-password: SONATYPE_PW
- name: Set version
run: |
VERSION=`git describe --match "v[0-9\.]*" --long --dirty --always`
mvn -B versions:set -DnewVersion=${VERSION:1} -DgenerateBackupPoms=false
- name: Release to Maven Central
env:
SONATYPE_USER: ${{ secrets.SONATYPE_USER }}
SONATYPE_PW: ${{ secrets.SONATYPE_PW }}
run: |
cat <(echo -e "${{ secrets.GPG_KEY }}") | gpg --batch --import
gpg --list-secret-keys --keyid-format LONG
mvn \
--no-transfer-progress \
--batch-mode \
-Dgpg.passphrase="${{ secrets.GPG_PW }}" \
-Drelease=true \
-DskipTests \
deploy

4
.gitignore vendored
View File

@ -7,7 +7,3 @@
.project
.settings/
bin/
# Ignore IntelliJ IDEA files
.idea
*.iml

View File

@ -4,7 +4,7 @@ The Interactive Connectivity Establishment (ICE) protocol combines various NAT t
This project provides a Java implementation of the ICE protocol that would be usable by both SIP and XMPP applications. The project also provides features such as socket sharing and support for Pseudo TCP.
ice4j is maintained by the [Jitsi](https://jitsi.org/) community. Use Jitsi's [community forum](https://community.jitsi.org) for questions and discussions.
ice4j is maintained by the [Jitsi](https://jitsi.org/) community. Use Jitsi's [dev mailing list](https://jitsi.org/Development/MailingLists) for questions and discussions.
Thanks
------

View File

@ -1,6 +0,0 @@
Export-Package: org.ice4j.*
Import-Package: *;version=!
Bundle-SymbolicName: org.jitsi.ice4j
-noextraheaders: true
-snapshot: SNAPSHOT
-removeheaders: Require-Capability, Bundle-SCM

View File

@ -1,40 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="SuppressWithPlainTextCommentFilter"/>
<module name="LineLength">
<property name="fileExtensions" value="java"/>
<property name="max" value="120"/>
<property name="ignorePattern" value="http://|https://"/>
</module>
<module name="TreeWalker">
<module name="LeftCurly">
<property name="option" value="nl"/>
<property name="tokens" value="LITERAL_CATCH"/>
<property name="tokens" value="LITERAL_ELSE"/>
<property name="tokens" value="LITERAL_FINALLY"/>
<property name="tokens" value="LITERAL_IF"/>
<property name="tokens" value="LITERAL_TRY"/>
</module>
<!-- Skips empty blocks {}, to not skip them: value="alone" -->
<module name="RightCurly">
<property name="option" value="alone_or_singleline"/>
</module>
<module name="WhitespaceAfter">
<!-- Drops TYPECAST from default tokens -->
<property name="tokens" value="COMMA , SEMI , LITERAL_IF , LITERAL_ELSE , LITERAL_WHILE , LITERAL_DO , LITERAL_FOR , DO_WHILE"/>
</module>
</module>
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
</module>

414
pom.xml
View File

@ -1,119 +1,42 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.jitsi</groupId>
<artifactId>jitsi-universe-public</artifactId>
<version>1.0</version>
</parent>
<artifactId>ice4j</artifactId>
<version>3.0-SNAPSHOT</version>
<version>2.0.0-SNAPSHOT</version>
<packaging>bundle</packaging>
<name>ice4j</name>
<description>A Java implementation of the ICE protocol</description>
<url>https://github.com/jitsi/ice4j</url>
<organization>
<name>jitsi.org</name>
<url>https://jitsi.org</url>
</organization>
<developers>
<developer>
<id>org.jitsi</id>
<name>Jitsi Team</name>
<email>dev@jitsi.org</email>
</developer>
</developers>
<scm>
<url>https://github.com/jitsi/ice4j</url>
<connection>scm:git:https://github.com/jitsi/ice4j.git</connection>
<developerConnection>scm:git:https://github.com/jitsi/ice4j.git</developerConnection>
<tag>HEAD</tag>
</scm>
<licenses>
<license>
<name>Apache-2.0</name>
<url>https://github.com/jitsi/ice4j/blob/master/LICENSE</url>
<distribution>repo</distribution>
</license>
</licenses>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<jicoco.version>1.1-127-gf49982f</jicoco.version>
<kotlin.version>1.9.10</kotlin.version>
<dokka.version>1.9.0</dokka.version>
<kotest.version>5.7.2</kotest.version>
<junit.version>5.10.0</junit.version>
</properties>
<dependencies>
<dependency>
<groupId>org.opentelecoms.sdp</groupId>
<artifactId>java-sdp-nist-bridge</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>org.jitsi</groupId>
<artifactId>jain-sip-ri-ossonly</artifactId>
</dependency>
<dependency>
<groupId>org.bitlet</groupId>
<artifactId>weupnp</artifactId>
<version>0.1.4</version>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>jitsi-utils</artifactId>
<version>1.0-127-g6c65524</version>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>jicoco-config</artifactId>
<version>${jicoco.version}</version>
</dependency>
<!-- test -->
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-launcher</artifactId>
<version>1.10.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.kotest</groupId>
<artifactId>kotest-assertions-core-jvm</artifactId>
<version>${kotest.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.kotest</groupId>
<artifactId>kotest-runner-junit5-jvm</artifactId>
<version>${kotest.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jitsi</groupId>
<artifactId>jicoco-test-kotlin</artifactId>
<version>${jicoco.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>4.5.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.mockk</groupId>
<artifactId>mockk-jvm</artifactId>
<version>1.13.8</version>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
@ -121,172 +44,58 @@
<build>
<plugins>
<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${kotlin.version}</version>
<executions>
<execution>
<id>compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
<sourceDir>${project.basedir}/src/main/java</sourceDir>
</sourceDirs>
</configuration>
</execution>
<execution>
<id>test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>test-compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
<sourceDir>${project.basedir}/src/test/java</sourceDir>
</sourceDirs>
</configuration>
</execution>
</executions>
<configuration>
<jvmTarget>11</jvmTarget>
<args>
<arg>-Xallow-result-return-type</arg>
</args>
</configuration>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.10.1</version>
<executions>
<!-- Replacing default-compile as it is treated specially by maven -->
<execution>
<id>default-compile</id>
<phase>none</phase>
</execution>
<!-- Replacing default-testCompile as it is treated specially by maven -->
<execution>
<id>default-testCompile</id>
<phase>none</phase>
</execution>
<execution>
<id>java-compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
<execution>
<id>java-test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>testCompile</goal>
</goals>
</execution>
</executions>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.4</version>
<configuration>
<release>11</release>
<compilerArgs>
<arg>-Xlint:all</arg>
</compilerArgs>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.2</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
</configuration>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>10.1</version>
</dependency>
</dependencies>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.github.gantsign.maven</groupId>
<artifactId>ktlint-maven-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<sourceRoots>
<sourceRoot>${project.basedir}/src/main/kotlin</sourceRoot>
</sourceRoots>
<testSourceRoots>
<testSourceRoot>${project.basedir}/src/test/kotlin</testSourceRoot>
</testSourceRoots>
</configuration>
<executions>
<execution>
<id>check</id>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>biz.aQute.bnd</groupId>
<artifactId>bnd-maven-plugin</artifactId>
<version>6.2.0</version>
<executions>
<execution>
<goals>
<goal>bnd-process</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.2</version>
<configuration>
<archive>
<manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
</archive>
<show>private</show>
<nohelp>true</nohelp>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M6</version>
<configuration>
<includes>**/*</includes>
<systemPropertyVariables>
<java.util.logging.config.file>${project.build.testSourceDirectory}/../resources/logging.properties</java.util.logging.config.file>
</systemPropertyVariables>
<includes>
<include>**/*TestSuite.*</include>
</includes>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.0.0-M2</version>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.13</version>
<extensions>true</extensions>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.10.0</version>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
<newVersion>
<file>
<path>${project.build.directory}/${project.build.finalName}.jar</path>
</file>
</newVersion>
<oldVersion>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>1.0.0</version>
</dependency>
</oldVersion>
<parameter>
<onlyModified>true</onlyModified>
<breakBuildBasedOnSemanticVersioning>true</breakBuildBasedOnSemanticVersioning>
<reportOnlyFilename>true</reportOnlyFilename>
</parameter>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>cmp</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
@ -295,7 +104,6 @@
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<goals>
@ -319,31 +127,25 @@
<profiles>
<profile>
<id>coverage</id>
<id>skip-pre-jdk8</id>
<activation>
<jdk>(,1.8)</jdk>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.8</version>
<executions>
<execution>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>test</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
</executions>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<excludes>
<exclude>**/jdk8/**</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>run-sample</id>
<build>
@ -448,95 +250,5 @@
</plugins>
</build>
</profile>
<profile>
<id>release</id>
<activation>
<property>
<name>release</name>
<value>true</value>
</property>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.3.0</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>add-source</goal>
</goals>
<configuration>
<sources>
<source>src/main/kotlin</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<phase>verify</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<version>${dokka.version}</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>javadocJar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.0.1</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
</project>

View File

@ -59,6 +59,43 @@ public class StackProperties
*/
public static final String BIND_WILDCARD = "org.ice4j.BIND_WILDCARD";
/**
* How often a STUN Binding request used for consent freshness check will be
* sent(value in milliseconds).
*/
public static final String CONSENT_FRESHNESS_INTERVAL
= "org.ice4j.ice.CONSENT_FRESHNESS_INTERVAL";
/**
* The maximum number of retransmissions of a STUN Binding request without
* a valid STUN Binding response after which consent freshness is to be
* considered unconfirmed according to &quot;STUN Usage for Consent
* Freshness&quot;.
*/
public static final String CONSENT_FRESHNESS_MAX_RETRANSMISSIONS
= "org.ice4j.ice.CONSENT_FRESHNESS_MAX_RETRANSMISSIONS";
/**
* The number of milliseconds without a valid STUN Binding response after
* which a STUN Binding request is to be retransmitted according to
* &quot;STUN Usage for Consent Freshness&quot;. This is the final value
* for the back-off strategy.
* {@link #CONSENT_FRESHNESS_ORIGINAL_WAIT_INTERVAL} defines the initial
* interval for the first request sent. Value in milliseconds.
*/
public static final String CONSENT_FRESHNESS_MAX_WAIT_INTERVAL
= "org.ice4j.ice.CONSENT_FRESHNESS_MAX_WAIT_INTERVAL";
/**
* The number of milliseconds without a valid STUN Binding response after
* which a STUN Binding request is to be retransmitted according to
* &quot;STUN Usage for Consent Freshness&quot;. This is the original value
* for back-off strategy. {@link #CONSENT_FRESHNESS_MAX_WAIT_INTERVAL} sets
* the upper limit. Value in milliseconds.
*/
public static final String CONSENT_FRESHNESS_ORIGINAL_WAIT_INTERVAL
= "org.ice4j.ice.CONSENT_FRESHNESS_WAIT_INTERVAL";
/**
* The number of milliseconds a client transaction should wait before
* retransmitting, after it has sent a request for the first time.
@ -86,6 +123,19 @@ public class StackProperties
public static final String MAX_CTRAN_RETRANSMISSIONS
= "org.ice4j.MAX_RETRANSMISSIONS";
/**
* The name of the System property that allows us to set a custom maximum
* for check list sizes.
*/
public static final String MAX_CHECK_LIST_SIZE
= "org.ice4j.MAX_CHECK_LIST_SIZE";
/**
* The value of the SOFTWARE attribute that ice4j should include in all
* outgoing messages.
*/
public static final String SOFTWARE = "org.ice4j.SOFTWARE";
/**
* The name of the property that tells the stack whether or not it should
* let the application see retransmissions of incoming requests.
@ -114,6 +164,14 @@ public class StackProperties
public static final String REQUIRE_MESSAGE_INTEGRITY
= "org.ice4j.REQUIRE_MESSAGE_INTEGRITY";
/**
* The name of the property that can be used to specify the number of
* milliseconds that we must wait after ICE processing enters a COMPLTED
* state and before we free candidates and move into the TERMINATED state.
*/
public static final String TERMINATION_DELAY
= "org.ice4j.TERMINATION_DELAY";
/**
* The name of the property that can be used to disable STUN keep alives.
* Set to <tt>true</tt> to disable.
@ -132,6 +190,11 @@ public class StackProperties
public static final String NOMINATION_TIMER
= "org.ice4j.NOMINATION_TIMER";
/**
* The name of the property used to disabled IPv6 support.
*/
public static final String DISABLE_IPv6 = "org.ice4j.ipv6.DISABLED";
/**
* The name of the allowed interfaces property which specifies the allowed
* interfaces for host candidate allocations.
@ -156,6 +219,13 @@ public class StackProperties
public static final String ALLOWED_ADDRESSES
= "org.ice4j.ice.harvest.ALLOWED_ADDRESSES";
/**
* The name of the property which, if set to true, specifies that IPv6
* link local addresses should not be used for candidate allocations.
*/
public static final String DISABLE_LINK_LOCAL_ADDRESSES
= "org.ice4j.ice.harvest.DISABLE_LINK_LOCAL_ADDRESSES";
/**
* The name of the property which specifies a ";"-separated list of IP
* addresses that are not allowed to be used for host candidate allocations.
@ -166,6 +236,31 @@ public class StackProperties
public static final String BLOCKED_ADDRESSES
= "org.ice4j.ice.harvest.BLOCKED_ADDRESSES";
/**
* The name of the property which specifies whether the dynamic port UDP
* host harvester should be used by <tt>Agent</tt> instances.
*/
public static final String USE_DYNAMIC_HOST_HARVESTER
= "org.ice4j.ice.harvest.USE_DYNAMIC_HOST_HARVESTER";
/**
* Timeout, in seconds, of how long to wait for an individual harvest before timing out
*/
public static final String HARVESTING_TIMEOUT
= "org.ice4j.ice.harvest.HARVESTING_TIMEOUT";
/**
* The name of the property which specifies whether the per-component
* merging socket should be enabled by default (the default value can be
* overridden with {@link Agent#createComponent(IceMediaStream, Transport,
* int, int, int, KeepAliveStrategy, boolean)}.
* If enabled, the user of the library must use the socket instance provided
* by {@link Component#getSocket()}. Otherwise, the socket instance from the
* desired {@link CandidatePair} must be used.
*/
public static final String USE_COMPONENT_SOCKET
= "org.ice4j.ice.USE_COMPONENT_SOCKET";
/**
* Returns the String value of the specified property (minus all
* encompassing whitespaces)and null in case no property value was mapped

View File

@ -221,12 +221,10 @@ abstract class AddressAttribute extends Attribute
binValue[7] = (byte)(getPort() & 0x00FF);
//address
if (getFamily() == ADDRESS_FAMILY_IPV6)
{
if(getFamily() == ADDRESS_FAMILY_IPV6){
System.arraycopy(getAddressBytes(), 0, binValue, 8, 16);
}
else
{
else{
System.arraycopy(getAddressBytes(), 0, binValue, 8, 4);
}

View File

@ -43,8 +43,8 @@ public class AttributeDecoder
* @throws StunException if bytes is not a valid STUN attribute.
*/
public static Attribute decode(byte[] bytes,
int offset,
int length)
char offset,
char length)
throws StunException
{
if(bytes == null || bytes.length < Attribute.HEADER_LENGTH)

View File

@ -308,12 +308,12 @@ public class MessageIntegrityAttribute
logger.warning("Can not encode a message of type Indication.");
}
Objects.requireNonNull(key, "key=null; msgType=" + String.format("%04X", (int)msgType));
Objects.requireNonNull(key, "key=null; msgType=" + msgType);
//now calculate the HMAC-SHA1
this.hmacSha1Content = calculateHmacSha1(content, offset, length, key);
//username
System.arraycopy(hmacSha1Content, 0, binValue, HEADER_LENGTH, getDataLength());
System.arraycopy(hmacSha1Content, 0, binValue, 4, getDataLength());
return binValue;
}

File diff suppressed because it is too large Load Diff

View File

@ -17,11 +17,11 @@
*/
package org.ice4j.ice;
import org.jitsi.utils.logging2.*;
import java.beans.*;
import java.util.*;
import org.ice4j.util.Logger;
/**
* A check list is a list of <tt>CandidatePair</tt>s with a state (i.e. a
* <tt>CheckListState</tt>). The pairs in a check list are those that an ICE
@ -35,6 +35,15 @@ import java.util.*;
public class CheckList
extends Vector<CandidatePair>
{
/**
* The class logger.
* Note that this shouldn't be used directly by instances of
* {@link CheckList}, because it doesn't take into account the per-instance
* log level. Instances should use {@link #logger} instead.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger(CheckList.class.getName());
/**
* A dummy serialization id.
*/
@ -98,7 +107,8 @@ public class CheckList
protected CheckList(IceMediaStream parentStream)
{
this.parentStream = parentStream;
logger = parentStream.getLogger().createChildLogger(this.getClass().getName());
logger
= new Logger(classLogger, parentStream.getParentAgent().getLogger());
}
/**
@ -209,25 +219,6 @@ public class CheckList
return highestPriorityPair; //return even if null
}
/**
* Returns a pair which matches the specified local and remote candidates'
* transport addresses, if any, otherwise null.
*/
public synchronized CandidatePair findPairMatching(LocalCandidate local, RemoteCandidate remote)
{
for (CandidatePair pair : this)
{
if (pair.getLocalCandidate() == local ||
pair.getLocalCandidate().getTransportAddress().equals(local.getTransportAddress()))
{
if (pair.getRemoteCandidate() == remote ||
pair.getRemoteCandidate().getTransportAddress().equals(remote.getTransportAddress()))
return pair;
}
}
return null;
}
/**
* Determines whether this <tt>CheckList</tt> can be considered active.
* RFC 5245 says: A check list with at least one pair that is Waiting is

View File

@ -18,13 +18,15 @@
package org.ice4j.ice;
import java.beans.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.socket.*;
import org.jitsi.utils.logging2.*;
import org.ice4j.util.Logger; //Disambiguation
/**
* A component is a piece of a media stream requiring a single transport
@ -41,6 +43,15 @@ import org.jitsi.utils.logging2.*;
public class Component
implements PropertyChangeListener
{
/**
* Our class logger.
* Note that this shouldn't be used directly by instances of
* {@link IceMediaStream}, because it doesn't take into account the
* per-instance log level.updateRemoteCandidates Instances should use {@link #logger} instead.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger(Component.class.getName());
/**
* The component ID to use with RTP streams.
*/
@ -164,10 +175,9 @@ public class Component
*/
protected Component(int componentID,
IceMediaStream mediaStream,
KeepAliveStrategy keepAliveStrategy,
Logger parentLogger)
KeepAliveStrategy keepAliveStrategy)
{
this(componentID, mediaStream, keepAliveStrategy, true, parentLogger);
this(componentID, mediaStream, keepAliveStrategy, true);
}
/**
@ -182,24 +192,21 @@ public class Component
protected Component(int componentID,
IceMediaStream mediaStream,
KeepAliveStrategy keepAliveStrategy,
boolean useComponentSocket,
Logger parentLogger)
boolean useComponentSocket)
{
// the max value for componentID is 256
this.componentID = componentID;
this.parentStream = mediaStream;
this.keepAliveStrategy
= Objects.requireNonNull(keepAliveStrategy, "keepAliveStrategy");
this.logger = parentLogger.createChildLogger(
this.getClass().getName(),
Collections.singletonMap("componentId", Integer.toString(componentID))
);
Logger agentLogger = mediaStream.getParentAgent().getLogger();
if (useComponentSocket)
{
try
{
componentSocket = new ComponentSocket(this, logger);
componentSocket = new ComponentSocket(this, agentLogger);
socket = new MultiplexingDatagramSocket(componentSocket);
socketWrapper = new IceUdpSocketWrapper(socket);
}
@ -216,6 +223,7 @@ public class Component
}
mediaStream.addPairChangeListener(this);
logger = new Logger(classLogger, agentLogger);
}
/**
@ -435,6 +443,9 @@ public class Component
= getParentStream()
.getParentAgent()
.createCandidatePair(localCnd, remoteCnd);
logger.info("new Pair added: " + pair.toShortString()
+ ". Local ufrag "
+ parentStream.getParentAgent().getLocalUfrag());
checkList.add(pair);
}
}
@ -460,28 +471,8 @@ public class Component
synchronized(streamCheckList)
{
for (CandidatePair pair : checkList)
{
/* Check whether the pair is already in the check list.
* (This can happen for pairs with remote peer-reflexive candidates,
* since those candidates aren't added to the candidate list even
* though the pair is added to the check list).
*/
CandidatePair existingPair
= streamCheckList.findPairMatching(pair.getLocalCandidate(), pair.getRemoteCandidate());
if (existingPair != null)
{
logger.info("existing Pair updated: " +
existingPair.toShortString() +
" to " + pair.toShortString() + ".");
existingPair.setRemoteCandidate(pair.getRemoteCandidate());
existingPair.computePriority();
}
else
{
streamCheckList.add(pair);
logger.info("new Pair added: " + pair.toShortString()
+ ".");
}
}
}
}
@ -703,7 +694,11 @@ public class Component
&& (cand.getPriority() >= cand2.getPriority()))
{
localCandidates.remove(j);
logger.trace(() -> "eliminating redundant cand: "+ cand2);
if (logger.isLoggable(Level.FINEST))
{
logger.finest(
"eliminating redundant cand: "+ cand2);
}
}
else
j++;
@ -904,7 +899,12 @@ public class Component
*/
if (t instanceof ThreadDeath)
throw (ThreadDeath) t;
logger.info(() -> "Failed to free LocalCandidate: " + localCandidate);
if (logger.isLoggable(Level.INFO))
{
logger.log(
Level.INFO,
"Failed to free LocalCandidate: " + localCandidate);
}
}
}
@ -921,47 +921,10 @@ public class Component
*/
public LocalCandidate findLocalCandidate(TransportAddress localAddress)
{
return findLocalCandidate(localAddress, null);
}
/**
* Returns the local <tt>LocalCandidate</tt> with the specified
* <tt>address</tt> if it belongs to this component or <tt>null</tt>
* if it doesn't. If {@code base} is also specified, tries to find a
* candidate whose base matches {@code base}.
*
* @param address the {@link TransportAddress} we are looking for.
* @param base an optional base to match.
*
* @return the local <tt>LocalCandidate</tt> with the specified
* <tt>address</tt> if it belongs to this component or <tt>null</tt>
* if it doesn't.
*/
public LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)
for (LocalCandidate localCnd : localCandidates)
{
for (LocalCandidate localCandidate : localCandidates)
{
if (localCandidate.getTransportAddress().equals(address))
{
if (base == null || base.equals(localCandidate.getBase()))
{
return localCandidate;
}
}
}
// In case the above loop failed to find a result because `base` was
// specified, fallback to the original behavior and return the first
// candidate matching `address` regardless of `base`.
for (LocalCandidate localCandidate : localCandidates)
{
if (localCandidate.getTransportAddress().equals(address))
{
logger.warn("Returning a candidate matching the address, "
+ "while no candidates match both address ("
+ address + ") and base (" + base +"): " + localCandidate
+ " with base " + localCandidate.getBase());
return localCandidate;
}
if (localCnd.getTransportAddress().equals(localAddress))
return localCnd;
}
return null;
@ -1054,16 +1017,15 @@ public class Component
* parent of this component.
* @return Component
*/
public static Component build(int componentID, IceMediaStream mediaStream, Logger parentLogger)
public static Component build(int componentID, IceMediaStream mediaStream)
{
return
new Component(
componentID,
mediaStream,
KeepAliveStrategy.SELECTED_ONLY,
AgentConfig.config.getUseComponentSocket(),
parentLogger
);
StackProperties.getBoolean(
StackProperties.USE_COMPONENT_SOCKET, true));
}
/**
@ -1174,9 +1136,4 @@ public class Component
keepAlivePairs.add(pair);
}
}
public Logger getLogger()
{
return logger;
}
}

View File

@ -33,6 +33,14 @@ public class ComponentSocket
extends MergingDatagramSocket
implements PropertyChangeListener
{
/**
* The {@link Logger} used by the {@link MergingDatagramSocket} class and
* its instances for logging output.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger
(MergingDatagramSocket.class.getName());
/**
* Controls access to {@link #authorizedAddresses}.
*/
@ -60,16 +68,22 @@ public class ComponentSocket
*/
private final Object initializedActiveSyncRoot = new Object();
/**
* The {@link Logger} used by {@link MergingDatagramSocket} instances.
*/
private final Logger logger;
/**
* Initializes a new {@link MergingDatagramSocket} instance.
* @throws SocketException
*/
ComponentSocket(Component component, org.jitsi.utils.logging2.Logger parentLogger)
ComponentSocket(Component component, Logger levelDelegate)
throws SocketException
{
super(parentLogger);
super(levelDelegate);
this.component = component;
this.logger = new Logger(classLogger, levelDelegate);
component.getParentStream().addPairChangeListener(this);
}
@ -155,9 +169,7 @@ public class ComponentSocket
LocalCandidate localCandidate = pair.getLocalCandidate();
LocalCandidate base = localCandidate.getBase();
if (base != null)
{
localCandidate = base;
}
TransportAddress remoteAddress = null;
RemoteCandidate remoteCandidate = pair.getRemoteCandidate();

View File

@ -18,17 +18,15 @@
package org.ice4j.ice;
import java.net.*;
import java.time.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.ice4j.message.*;
import org.ice4j.socket.*;
import org.ice4j.stack.*;
import org.ice4j.util.*;
import org.jitsi.utils.logging2.Logger;
import org.ice4j.util.Logger; //Disambiguation
/**
* The class that will be generating our outgoing connectivity checks and that
@ -40,21 +38,22 @@ import org.jitsi.utils.logging2.Logger;
class ConnectivityCheckClient
implements ResponseCollector
{
/**
* The <tt>Logger</tt> used by the <tt>ConnectivityCheckClient</tt>
* class for logging output.
* Note that this shouldn't be used directly by instances of
* {@link ConnectivityCheckClient}, because it doesn't take into account
* the per-instance log level. Instances should use {@link #logger} instead.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger(
ConnectivityCheckClient.class.getName());
/**
* The agent that created us.
*/
private final Agent parentAgent;
/**
* A scheduled executor service to perform periodic tasks of the client
*/
private final ScheduledExecutorService scheduledExecutorService;
/**
* An executor service to perform background tasks of the client
*/
private final ExecutorService executorService;
/**
* The <tt>StunStack</tt> that we will use for connectivity checks.
*/
@ -63,21 +62,13 @@ class ConnectivityCheckClient
/**
* The {@link PaceMaker}s that are currently running checks in this client.
*/
private final Queue<PaceMaker> paceMakers
= new ConcurrentLinkedQueue<>();
/**
* Whether this {@link ConnectivityCheckClient} has been stopped.
* Synchronized by {@link #paceMakers}.
*/
private boolean stopped = false;
private final List<PaceMaker> paceMakers = new LinkedList<>();
/**
* Timer that is used to let some seconds before a CheckList is considered
* as FAILED.
*/
private ConcurrentMap<String, ScheduledFuture<?>>
checkListCompletionCheckers = new ConcurrentHashMap<>();
private Map<String, Timer> timers = new HashMap<>();
/**
* A flag that determines whether we have received a STUN response or not.
@ -95,20 +86,11 @@ class ConnectivityCheckClient
* information such as user fragments for example.
*
* @param parentAgent the <tt>Agent</tt> that is creating this instance.
* @param scheduledExecutorService the <tt>ScheduledExecutorService</tt>
* to execute clients tasks
* @param executorService the <tt>ExecutorService</tt> to execute
* background tasks of connectivity check client
*/
public ConnectivityCheckClient(
Agent parentAgent,
ScheduledExecutorService scheduledExecutorService,
ExecutorService executorService)
public ConnectivityCheckClient(Agent parentAgent)
{
this.parentAgent = parentAgent;
this.scheduledExecutorService = scheduledExecutorService;
this.executorService = executorService;
logger = parentAgent.getLogger().createChildLogger(this.getClass().getName());
logger = new Logger(classLogger, parentAgent.getLogger());
stunStack = this.parentAgent.getStunStack();
}
@ -144,7 +126,8 @@ class ConnectivityCheckClient
if (streamsWithPendingConnectivityEstablishment.size() > 0)
{
logger.info("Start connectivity checks.");
logger.info("Start connectivity checks. Local ufrag "
+ parentAgent.getLocalUfrag());
startChecks(
streamsWithPendingConnectivityEstablishment
.get(0).getCheckList());
@ -165,16 +148,13 @@ class ConnectivityCheckClient
*/
public void startChecks(CheckList checkList)
{
PaceMaker paceMaker = new PaceMaker(checkList);
synchronized (paceMakers)
{
if (stopped)
{
return;
}
PaceMaker paceMaker = new PaceMaker(checkList);
paceMakers.add(paceMaker);
paceMaker.schedule();
}
paceMaker.start();
}
/**
@ -195,18 +175,23 @@ class ConnectivityCheckClient
indication,
candidatePair.getRemoteCandidate().getTransportAddress(),
localCandidate.getBase().getTransportAddress());
logger.trace(() ->
if (logger.isLoggable(Level.FINEST))
{
logger.finest(
"sending binding indication to pair " + candidatePair);
}
}
catch (Exception ex)
{
IceSocketWrapper stunSocket = localCandidate.getStunSocket(null);
if (stunSocket != null)
{
logger.info("Failed to send " + indication + " through "
+ stunSocket.getLocalSocketAddress() + "\n" +
ex.toString());
logger.log(
Level.INFO,
"Failed to send " + indication + " through "
+ stunSocket.getLocalSocketAddress(),
ex);
}
}
}
@ -277,7 +262,7 @@ class ConnectivityCheckClient
//nominated pairs.
if (candidatePair.isNominated())
{
logger.debug(() ->
logger.fine(
"Add USE-CANDIDATE in check for: "
+ candidatePair.toShortString());
request.putAttribute(
@ -321,12 +306,9 @@ class ConnectivityCheckClient
tran.setApplicationData(candidatePair);
if (logger.isDebugEnabled())
{
logger.debug(
logger.fine(
"start check for " + candidatePair.toShortString() + " tid "
+ tran);
}
try
{
tran
@ -340,15 +322,12 @@ class ConnectivityCheckClient
originalWaitInterval,
maxWaitInterval,
maxRetransmissions);
if (logger.isTraceEnabled())
if (logger.isLoggable(Level.FINEST))
{
logger.trace("checking pair " + candidatePair + " tid " + tran);
logger.finest(
"checking pair " + candidatePair + " tid " + tran);
}
}
catch (NetAccessManager.SocketNotFoundException e)
{
logger.info("Could not start connectivity check: " + e.getMessage());
}
catch (Exception ex)
{
tran = null;
@ -368,11 +347,7 @@ class ConnectivityCheckClient
msg += " No route to host.";
ex = null;
}
logger.info(msg + (ex == null ? "" : "\n" + ex.toString()));
}
else
{
logger.warn("Failed to send " + request, ex);
logger.log(Level.INFO, msg, ex);
}
}
@ -412,7 +387,7 @@ class ConnectivityCheckClient
{
if (!response.containsAttribute(Attribute.ERROR_CODE))
{
logger.debug(() -> "Received a malformed error response.");
logger.fine("Received a malformed error response.");
return; //malformed error response
}
@ -456,12 +431,14 @@ class ConnectivityCheckClient
if ( !stream.validListContainsAllComponents())
{
final String streamName = stream.getName();
if (!checkListCompletionCheckers.containsKey(streamName))
{
logger.info("CheckList will failed in a few seconds" +
" if no succeeded checks come");
Timer timer = timers.get(streamName);
Runnable checkLickCompletedChecker = new Runnable()
if (timer == null)
{
logger.info("CheckList will failed in a few seconds if no" +
"succeeded checks come");
TimerTask task = new TimerTask()
{
@Override
public void run()
@ -476,20 +453,9 @@ class ConnectivityCheckClient
}
}
};
final ScheduledFuture<?> scheduledCheckerFuture
= scheduledExecutorService.schedule(
checkLickCompletedChecker,
5000,
TimeUnit.MILLISECONDS);
final ScheduledFuture<?> existingCheckerFuture
= checkListCompletionCheckers
.putIfAbsent(streamName, scheduledCheckerFuture);
if (existingCheckerFuture != null)
{
scheduledCheckerFuture.cancel(false);
}
timer = new Timer();
timers.put(streamName, timer);
timer.schedule(task, 5000);
}
}
@ -533,10 +499,11 @@ class ConnectivityCheckClient
if (!response.containsAttribute(Attribute.XOR_MAPPED_ADDRESS))
{
logger.debug(() -> "Received a success response with no "
logger.fine("Received a success response with no "
+ "XOR_MAPPED_ADDRESS attribute.");
logger.info("Pair failed (no XOR-MAPPED-ADDRESS): "
+ checkedPair.toShortString() + ".");
+ checkedPair.toShortString() + ". Local ufrag"
+ parentAgent.getLocalUfrag());
checkedPair.setStateFailed();
return; //malformed error response
}
@ -558,12 +525,9 @@ class ConnectivityCheckClient
Transport.TCP);
}
// In some situations we may have more than one local candidate matching
// the mapped address. In this case we want to find the that matches
// the socket we received the response on.
LocalCandidate base = checkedPair.getLocalCandidate().getBase();
LocalCandidate validLocalCandidate
= parentAgent.findLocalCandidate(mappedAddress, base);
LocalCandidate validLocalCandidate = null;
validLocalCandidate = parentAgent.findLocalCandidate(mappedAddress);
RemoteCandidate validRemoteCandidate = checkedPair.getRemoteCandidate();
@ -609,7 +573,7 @@ class ConnectivityCheckClient
{
logger.info("Receive a peer-reflexive candidate: "
+ peerReflexiveCandidate.getTransportAddress()
+ ".");
+ ". Local ufrag " + parentAgent.getLocalUfrag());
}
}
@ -647,7 +611,8 @@ class ConnectivityCheckClient
if (checkedPair.getParentComponent().getSelectedPair() == null)
{
logger.info("Pair succeeded: " + checkedPair.toShortString()
+ ".");
+ ". Local ufrag "
+ parentAgent.getLocalUfrag());
}
checkedPair.setStateSucceeded();
}
@ -656,7 +621,7 @@ class ConnectivityCheckClient
{
if (validPair.getParentComponent().getSelectedPair() == null)
logger.info("Pair validated: " + validPair.toShortString()
+ ".");
+ ". Local ufrag " + parentAgent.getLocalUfrag());
parentAgent.validatePair(validPair);
}
@ -728,7 +693,7 @@ class ConnectivityCheckClient
" USE-CANDIDATE:" +
(request.containsAttribute(Attribute.USE_CANDIDATE) ||
checkedPair.useCandidateSent())
+ ".");
+ ". Local ufrag " + parentAgent.getLocalUfrag());
}
//If the agent was a controlling agent, and it had included a USE-
@ -741,12 +706,12 @@ class ConnectivityCheckClient
{
logger.info("Nomination confirmed for pair: "
+ validPair.toShortString()
+ ".");
+ ". Loal ufrag " + parentAgent.getLocalUfrag());
parentAgent.nominationConfirmed( validPair );
}
else
{
logger.debug(() ->
logger.fine(
"Keep alive for pair: " + validPair.toShortString());
}
}
@ -768,7 +733,7 @@ class ConnectivityCheckClient
}
else
{
logger.debug(() ->
logger.fine(
"Keep alive for pair: " + validPair.toShortString());
}
}
@ -838,7 +803,7 @@ class ConnectivityCheckClient
CandidatePair pair
= (CandidatePair) ev.getTransactionID().getApplicationData();
logger.trace(() -> "Received error code " + ((int) errorCode));
logger.finer("Received error code " + ((int) errorCode));
//RESOLVE ROLE_CONFLICTS
if (errorCode == ErrorCodeAttribute.ROLE_CONFLICT)
@ -846,7 +811,7 @@ class ConnectivityCheckClient
boolean wasControlling
= originalRequest.containsAttribute(Attribute.ICE_CONTROLLING);
logger.trace(() -> "Switching to isControlling=" + !wasControlling);
logger.finer("Switching to isControlling=" + !wasControlling);
parentAgent.setControlling(!wasControlling);
pair.getParentComponent().getParentStream().getCheckList()
@ -855,12 +820,10 @@ class ConnectivityCheckClient
else
{
int code = cl * 100 + co;
String reason = errorAttr.getReasonPhrase();
String trimmedReason = reason != null ? reason.trim() : null;
logger.info(
"Error response for pair: " + pair.toShortString() +
", failing. Code = " + code +
"(class=" + cl + "; number=" + co + "): " + trimmedReason);
"(class=" + cl + "; number=" + co + ")");
pair.setStateFailed();
}
}
@ -884,11 +847,17 @@ class ConnectivityCheckClient
}
/**
* A class to control periodically scheduled runnable that actually sends
* the checks for a particular check list in the pace defined in RFC 5245.
* The thread that actually sends the checks for a particular check list
* in the pace defined in RFC 5245.
*/
private final class PaceMaker extends PeriodicRunnable
private class PaceMaker
extends Thread
{
/**
* Indicates whether this <tt>Thread</tt> should still be running.
*/
boolean running = true;
/**
* The {@link CheckList} that this <tt>PaceMaker</tt> will be running
* checks for.
@ -904,8 +873,39 @@ class ConnectivityCheckClient
*/
public PaceMaker(CheckList checkList)
{
super(scheduledExecutorService, executorService);
super("ICE PaceMaker: " + parentAgent.getLocalUfrag());
this.checkList = checkList;
/*
* Because PaceMaker does not seem to be a daemon at least on Ubuntu
* in the run-sample target and it looks like it should be from the
* standpoint of the application, explicitly tell it to be a daemon.
* Otherwise, it could prevent the application from exiting because
* of a problem in the ICE implementation.
*/
setDaemon(true);
}
/**
* Returns the number milliseconds to wait before we send the next
* check.
*
* @return the number milliseconds to wait before we send the next
* check.
*/
private long getNextWaitInterval()
{
int activeCheckLists = parentAgent.getActiveCheckListCount();
if (activeCheckLists < 1)
{
//don't multiply by 0. even when we no longer have active check
//lists we may still have nomination checks to
activeCheckLists = 1;
}
return parentAgent.calculateTa() * activeCheckLists;
}
/**
@ -914,15 +914,39 @@ class ConnectivityCheckClient
* or the regular check lists.
*/
@Override
protected void run()
public synchronized void run()
{
try
{
while(running)
{
long waitFor = getNextWaitInterval();
if (waitFor > 0)
{
/*
* waitFor will be 0 for the first check since we won't
* have any active check lists at that point yet.
*/
try
{
wait(waitFor);
}
catch (InterruptedException e)
{
logger.log(Level.FINER, "PaceMaker got interrupted",
e);
}
if (!running)
break;
}
CandidatePair pairToCheck = checkList.popTriggeredCheck();
//if there are no triggered checks, go for an ordinary one.
if (pairToCheck == null)
{
pairToCheck = checkList.getNextOrdinaryPairToCheck();
}
if (pairToCheck != null)
{
@ -946,11 +970,9 @@ class ConnectivityCheckClient
pairToCheck.setStateFailed();
}
else
{
pairToCheck.setStateInProgress(transactionID);
}
}
}
else
{
/*
@ -958,30 +980,21 @@ class ConnectivityCheckClient
* its final state in either the processResponse(),
* processTimeout() or processFailure() method.
*/
logger.trace(() -> "will skip a check beat.");
logger.finest("will skip a check beat.");
checkList.fireEndOfOrdinaryChecks();
}
}
/**
* Returns the number milliseconds to wait before we send the next
* check.
*
* @return the number milliseconds to wait before we send the next
* check.
*/
protected Duration getDelayUntilNextRun()
{
int activeCheckLists = parentAgent.getActiveCheckListCount();
if (activeCheckLists < 1)
{
//don't multiply by 0. even when we no longer have active check
//lists we may still have nomination checks to
activeCheckLists = 1;
}
return Duration.ofMillis(parentAgent.calculateTa() * activeCheckLists);
finally
{
synchronized (paceMakers)
{
synchronized (this)
{
paceMakers.remove(this);
}
}
}
}
}
@ -992,15 +1005,19 @@ class ConnectivityCheckClient
{
synchronized (paceMakers)
{
stopped = true;
while (true)
Iterator<PaceMaker> paceMakersIter = paceMakers.iterator();
while(paceMakersIter.hasNext())
{
final PaceMaker paceMaker = paceMakers.poll();
if (paceMaker == null)
PaceMaker paceMaker = paceMakersIter.next();
synchronized (paceMaker)
{
break;
paceMaker.running = false;
paceMaker.notify();
}
paceMaker.cancel();
paceMakersIter.remove();
}
}
}

View File

@ -17,12 +17,14 @@
*/
package org.ice4j.ice;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.ice4j.message.*;
import org.ice4j.security.*;
import org.ice4j.stack.*;
import org.jitsi.utils.logging2.*;
import org.ice4j.util.Logger; // Disambiguation.
/**
* The class that would be handling and responding to incoming connectivity
@ -35,6 +37,34 @@ class ConnectivityCheckServer
implements RequestListener,
CredentialsAuthority
{
/**
* The <tt>Logger</tt> used by the <tt>ConnectivityCheckServer</tt>
* class and its instances for logging output.
* Note that this shouldn't be used directly by instances of
* {@link ConnectivityCheckServer}, because it doesn't take into account
* the per-instance log level. Instances should use {@link #logger} instead.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger(
ConnectivityCheckServer.class.getName());
/**
* Compares <tt>a</tt> and <tt>b</tt> as unsigned long values. Serves the
* same purpose as the <tt>Long.compareUnsigned</tt> method available in
* Java 1.8.
* @return <tt>-1</tt> if <tt>a</tt> is less than <tt>b</tt>, <tt>0</tt> if
* they are equal and <tt>1</tt> if <tt>a</tt> is bigger.
*/
private static int compareUnsignedLong(long a, long b)
{
if (a == b)
return 0;
else if ((a + Long.MIN_VALUE) < (b + Long.MIN_VALUE))
return -1;
else
return 1;
}
/**
* The agent that created us.
*/
@ -71,7 +101,7 @@ class ConnectivityCheckServer
public ConnectivityCheckServer(Agent parentAgent)
{
this.parentAgent = parentAgent;
logger = parentAgent.getLogger().createChildLogger(this.getClass().getName());
logger = new Logger(classLogger, parentAgent.getLogger());
stunStack = this.parentAgent.getStunStack();
stunStack.getCredentialsManager().registerAuthority(this);
@ -111,7 +141,8 @@ class ConnectivityCheckServer
public void processRequest(StunMessageEvent evt)
throws IllegalArgumentException
{
logger.trace(() -> "Received request " + evt);
if(logger.isLoggable(Level.FINER))
logger.finer("Received request " + evt);
alive = true;
@ -181,9 +212,11 @@ class ConnectivityCheckServer
}
catch (Exception e)
{
logger.info("Failed to send " + response
+ " through " + evt.getLocalAddress() + "\n" +
e.toString());
logger.log(
Level.INFO,
"Failed to send " + response
+ " through " + evt.getLocalAddress(),
e);
//try to trigger a 500 response although if this one failed,
//then chances are the 500 will fail too.
throw new RuntimeException("Failed to send a response", e);
@ -216,8 +249,11 @@ class ConnectivityCheckServer
//extract priority
if(priorityAttr == null)
{
logger.debug(() -> "Received a connectivity check with"
if(logger.isLoggable(Level.FINE))
{
logger.log(Level.FINE, "Received a connectivity check with"
+ "no PRIORITY attribute. Discarding.");
}
throw new IllegalArgumentException("Missing PRIORITY attribute!");
}
@ -242,51 +278,29 @@ class ConnectivityCheckServer
*/
private boolean repairRoleConflict(StunMessageEvent evt)
{
final Message req = evt.getMessage();
final boolean selfIceControlling = parentAgent.isControlling();
Message req = evt.getMessage();
long ourTieBreaker = parentAgent.getTieBreaker();
// If the agent is in the controlling role, and the
// ICE-CONTROLLING attribute is present in the request:
final boolean bothControllingConflict = selfIceControlling &&
req.containsAttribute(Attribute.ICE_CONTROLLING);
// If the agent is in the controlled role, and the ICE-CONTROLLED
// attribute is present in the request:
final boolean bothControlledConflict = !selfIceControlling &&
req.containsAttribute(Attribute.ICE_CONTROLLED);
if (!(bothControllingConflict || bothControlledConflict))
if(parentAgent.isControlling()
&& req.containsAttribute(Attribute.ICE_CONTROLLING))
{
// we don't have a role conflict
return true;
}
IceControllingAttribute controlling = (IceControllingAttribute)
req.getAttribute(Attribute.ICE_CONTROLLING);
final long selfTieBreaker = parentAgent.getTieBreaker();
final IceControlAttribute theirIceControl = bothControllingConflict
? (IceControlAttribute)req.getAttribute(Attribute.ICE_CONTROLLING)
: (IceControlAttribute)req.getAttribute(Attribute.ICE_CONTROLLED);
final long theirTieBreaker = theirIceControl.getTieBreaker();
long theirTieBreaker = controlling.getTieBreaker();
// If the agent's tie-breaker is larger than or equal to the
// contents of the ICE control attribute, the agent generates
// contents of the ICE-CONTROLLING attribute, the agent generates
// a Binding error response and includes an ERROR-CODE attribute
// with a value of 487 (Role Conflict) but retains its role.
if (Long.compareUnsigned(selfTieBreaker, theirTieBreaker) >= 0)
if(compareUnsignedLong(ourTieBreaker, theirTieBreaker) >= 0)
{
final UsernameAttribute requestUserName = (UsernameAttribute)req
.getAttribute(Attribute.USERNAME);
final Response response =
MessageFactory.createBindingErrorResponse(
Response response = MessageFactory.createBindingErrorResponse(
ErrorCodeAttribute.ROLE_CONFLICT);
final Attribute messageIntegrityAttribute =
AttributeFactory.createMessageIntegrityAttribute(
new String(requestUserName.getUsername()));
response.putAttribute(messageIntegrityAttribute);
try
{
stunStack.sendResponse(
@ -294,6 +308,7 @@ class ConnectivityCheckServer
response,
evt.getLocalAddress(),
evt.getRemoteAddress());
return false;
}
catch(Exception exc)
@ -303,19 +318,68 @@ class ConnectivityCheckServer
}
}
//If the agent's tie-breaker is less than the contents of the
//ICE control attribute, the agent toggles its ICE control role.
//ICE-CONTROLLING attribute, the agent switches to the controlled
//role.
else
{
final String selfNextControlState
= selfIceControlling ? "controlled" : "controlling";
logger.trace(() ->
"Switching to " + selfNextControlState + " because " +
" theirTieBreaker= " + theirTieBreaker + " and " +
"selfTieBreaker= " + selfTieBreaker);
parentAgent.setControlling(!selfIceControlling);
logger.finer(
"Switching to controlled because theirTieBreaker="
+ theirTieBreaker + " and ourTieBreaker="
+ ourTieBreaker);
parentAgent.setControlling(false);
return true;
}
}
// If the agent is in the controlled role, and the ICE-CONTROLLED
// attribute is present in the request:
else if(!parentAgent.isControlling()
&& req.containsAttribute(Attribute.ICE_CONTROLLED))
{
IceControlledAttribute controlled = (IceControlledAttribute)
req.getAttribute(Attribute.ICE_CONTROLLED);
long theirTieBreaker = controlled.getTieBreaker();
//If the agent's tie-breaker is larger than or equal to the
//contents of the ICE-CONTROLLED attribute, the agent switches to
//the controlling role.
if(compareUnsignedLong(ourTieBreaker, theirTieBreaker) >= 0)
{
logger.finer(
"Switching to controlling because theirTieBreaker="
+ theirTieBreaker + " and ourTieBreaker="
+ ourTieBreaker);
parentAgent.setControlling(true);
return true;
}
// If the agent's tie-breaker is less than the contents of the
// ICE-CONTROLLED attribute, the agent generates a Binding error
// response and includes an ERROR-CODE attribute with a value of
// 487 (Role Conflict) but retains its role.
else
{
Response response = MessageFactory.createBindingErrorResponse(
ErrorCodeAttribute.ROLE_CONFLICT);
try
{
stunStack.sendResponse(
evt.getTransactionID().getBytes(),
response,
evt.getLocalAddress(),
evt.getRemoteAddress());
return false;
}
catch(Exception exc)
{
//rethrow so that we would send a 500 response instead.
throw new RuntimeException("Failed to send a 487", exc);
}
}
}
return true; // we don't have a role conflict
}
/**
* Verifies whether <tt>username</tt> is currently known to this server

View File

@ -17,11 +17,11 @@
*/
package org.ice4j.ice;
import org.jitsi.utils.logging2.*;
import java.beans.*;
import java.util.*;
import org.ice4j.util.*;
/**
* Implements ice4j internal nomination strategies.
*
@ -30,6 +30,15 @@ import java.util.*;
public class DefaultNominator
implements PropertyChangeListener
{
/**
* The class logger.
* Note that this shouldn't be used directly by instances of
* {@link DefaultNominator}, because it doesn't take into account the
* per-instance log level. Instances should use {@link #logger} instead.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger(DefaultNominator.class.getName());
/**
* The Agent that created us.
*/
@ -62,7 +71,7 @@ public class DefaultNominator
public DefaultNominator(Agent parentAgent)
{
this.parentAgent = parentAgent;
logger = parentAgent.getLogger().createChildLogger(this.getClass().getName());
logger = new Logger(classLogger, parentAgent.getLogger());
parentAgent.addStateChangeListener(this);
}
@ -98,20 +107,17 @@ public class DefaultNominator
if (ev.getSource() instanceof CandidatePair)
{
// STUN Usage for Consent Freshness is of no concern here.
if (IceMediaStream.PROPERTY_PAIR_CONSENT_FRESHNESS_CHANGED.equals(propertyName))
{
if (IceMediaStream.PROPERTY_PAIR_CONSENT_FRESHNESS_CHANGED.equals(
propertyName))
return;
}
CandidatePair validPair = (CandidatePair) ev.getSource();
Component parentComponent = validPair.getParentComponent();
IceMediaStream parentStream = parentComponent.getParentStream();
// do not nominate pair if there is currently a nominated pair for
// do not nominate pair if there is currently a selected pair for
// the component
if (parentStream.validListContainsNomineeForComponent(parentComponent))
if (validPair.getParentComponent().getSelectedPair() != null)
{
logger.debug(() ->
logger.fine(
"Keep-alive for pair: " + validPair.toShortString());
return;
}
@ -141,7 +147,7 @@ public class DefaultNominator
CandidatePair validPair = (CandidatePair)evt.getSource();
logger.info("Nominate (first valid): " + validPair.toShortString()
+ ".");
+ ". Local ufrag " + parentAgent.getLocalUfrag());
parentAgent.nominate(validPair);
}
}
@ -185,18 +191,6 @@ public class DefaultNominator
}
}
/**
* The {@link NominationStrategy} that this nominator is using when
* deciding whether or not a valid {@link CandidatePair} is suitable for
* nomination.
*
* @return the {@link NominationStrategy} we are using.
*/
public NominationStrategy getStrategy()
{
return strategy;
}
/**
* The {@link NominationStrategy} that this nominator should use when
* deciding whether or not a valid {@link CandidatePair} is suitable for

View File

@ -19,12 +19,9 @@ package org.ice4j.ice;
import java.beans.*;
import java.util.*;
import java.util.logging.Logger;
import org.ice4j.*;
import org.jitsi.utils.collections.*;
import org.jitsi.utils.logging2.*;
import static org.ice4j.ice.AgentConfig.config;
/**
* The class represents a media stream from the ICE perspective, i.e. a
@ -35,6 +32,15 @@ import static org.ice4j.ice.AgentConfig.config;
*/
public class IceMediaStream
{
/**
* Our class logger
* Note that this shouldn't be used directly by instances of
* {@link IceMediaStream}, because it doesn't take into account the
* per-instance log level. Instances should use {@link #logger} instead.
*/
private static final Logger classLogger =
Logger.getLogger(IceMediaStream.class.getName());
/**
* The property name that we use when delivering events notifying listeners
* that the consent freshness of a pair has changed.
@ -129,7 +135,7 @@ public class IceMediaStream
* across all check lists to a specific value, adn this value MUST be
* configurable. A default of 100 is RECOMMENDED.
*/
private int maxCheckListSize = config.getMaxCheckListSize();
private int maxCheckListSize = Agent.DEFAULT_MAX_CHECK_LIST_SIZE;
/**
* The user fragment that we received from the remote party.
@ -144,7 +150,7 @@ public class IceMediaStream
/**
* The {@link Logger} used by {@link IceMediaStream} instances.
*/
private Logger logger;
private org.ice4j.util.Logger logger;
/**
* Initializes a new <tt>IceMediaStream</tt> object.
@ -155,9 +161,7 @@ public class IceMediaStream
*/
protected IceMediaStream(Agent parentAgent, String name)
{
logger = parentAgent.getLogger().createChildLogger(
IceMediaStream.class.getName(),
Collections.singletonMap("name", name));
logger = new org.ice4j.util.Logger(classLogger, parentAgent.getLogger());
this.name = name;
this.parentAgent = parentAgent;
checkList = new CheckList(this);
@ -172,7 +176,7 @@ public class IceMediaStream
* @param keepAliveStrategy the keep-alive strategy, which dictates which
* candidates pairs are going to be kept alive.
* @param useComponentSocket whether the "component socket" should be used
* or not. See {@link AgentConfig#getUseComponentSocket()}.
* or not. See {@link StackProperties#USE_COMPONENT_SOCKET}.
*
* @return the newly created stream <tt>Component</tt> after adding it to
* the stream first.
@ -190,8 +194,7 @@ public class IceMediaStream
++lastComponentID,
this,
keepAliveStrategy,
useComponentSocket,
logger);
useComponentSocket);
components.put(component.getComponentID(), component);
}
@ -364,7 +367,7 @@ public class IceMediaStream
orderCheckList();
pruneCheckList(checkList);
logger.trace(() -> "Checklist initialized.");
logger.finest("Checklist initialized.");
}
}
@ -511,28 +514,23 @@ public class IceMediaStream
/**
* Returns the local <tt>LocalCandidate</tt> with the specified
* <tt>address</tt> if it belongs to any of this stream's components
* or <tt>null</tt> otherwise. If {@code base} is also specified, tries to
* find a candidate whose base matches {@code base}.
* <tt>localAddress</tt> if it belongs to any of this stream's components
* or <tt>null</tt> otherwise.
*
* @param address the {@link TransportAddress} we are looking for.
* @param base an optional base to match.
* @param localAddress the {@link TransportAddress} we are looking for.
*
* @return the local <tt>LocalCandidate</tt> with the specified
* <tt>address</tt> if it belongs to any of this stream's components
* <tt>localAddress</tt> if it belongs to any of this stream's components
* or <tt>null</tt> otherwise.
*/
public LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)
public LocalCandidate findLocalCandidate(TransportAddress localAddress)
{
for (Component component : components.values())
for( Component cmp : components.values())
{
LocalCandidate localCandidate
= component.findLocalCandidate(address, base);
LocalCandidate cnd = cmp.findLocalCandidate(localAddress);
if (localCandidate != null)
{
return localCandidate;
}
if(cnd != null)
return cnd;
}
return null;
@ -923,9 +921,4 @@ public class IceMediaStream
{
return remotePassword;
}
public Logger getLogger()
{
return logger;
}
}

View File

@ -19,11 +19,12 @@ package org.ice4j.ice;
import java.io.*;
import java.net.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.socket.*;
import org.ice4j.stack.*;
import org.jitsi.utils.logging2.*;
import org.ice4j.util.Logger; // Disambiguation.
/**
* <tt>LocalCandidate</tt>s are obtained by an agent for every stream component
@ -65,7 +66,7 @@ public abstract class LocalCandidate
/**
* The {@link Logger} used by {@link LocalCandidate} instances.
*/
private final Logger logger;
private Logger logger;
/**
* Creates a <tt>LocalCandidate</tt> instance for the specified transport
@ -90,10 +91,12 @@ public abstract class LocalCandidate
CandidateType type,
CandidateExtendedType extendedType,
LocalCandidate relatedCandidate)
{
super(transportAddress, parentComponent, type, relatedCandidate);
logger = parentComponent.getLogger().createChildLogger(this.getClass().getName());
logger
= new Logger(classLogger,
parentComponent.
getParentStream().getParentAgent().getLogger());
this.extendedType = extendedType;
}
@ -202,7 +205,8 @@ public abstract class LocalCandidate
}
catch (SocketException sex) //don't u just luv da name? ;)
{
logger.error("Failed to acquire Socket"
logger.log(Level.SEVERE,
"Failed to acquire Socket"
+ " specific to STUN communication.",
sex);
exception = sex;
@ -258,7 +262,8 @@ public abstract class LocalCandidate
}
catch (SocketException sex) //don't u just luv da name? ;)
{
logger.error("Failed to acquire DatagramSocket"
logger.log(Level.SEVERE,
"Failed to acquire DatagramSocket"
+ " specific to STUN communication.",
sex);
exception = sex;

View File

@ -44,11 +44,8 @@ public enum NominationStrategy
NOMINATE_FIRST_VALID("NominateFirstValid"),
/**
* The strategy consists in nominating the highest priority valid pair.
* Once a pair is validated, if no higher-priority pairs remain outstanding,
* it is nominated; otherwise, a timer is armed, and if higher-priority
* pairs are still outstanding after the timeout, the highest-priority validated
* pair is nominated.
* The strategy consists in nominating the highest priority valid pair once
* all checks in a list have completed.
*/
NOMINATE_HIGHEST_PRIO("NominateHighestPriority"),
@ -93,19 +90,4 @@ public enum NominationStrategy
{
return strategyName;
}
/**
* @return the {@link NominationStrategy} with name equal to the given
* string, or {@code null} if there is no such strategy.
* @param string the name of the strategy.
*/
public static NominationStrategy fromString(String string)
{
for (NominationStrategy strategy : NominationStrategy.values())
{
if (strategy.strategyName.equals(string))
return strategy;
}
return null;
}
}

View File

@ -19,6 +19,7 @@ package org.ice4j.ice.harvest;
import org.ice4j.*;
import org.ice4j.ice.*;
import org.ice4j.message.*;
import org.ice4j.socket.*;
import java.io.*;
@ -28,8 +29,6 @@ import java.nio.channels.*;
import java.util.*;
import java.util.logging.*;
import static org.ice4j.ice.harvest.HarvestConfig.config;
/**
* An abstract class that binds on a set of sockets and accepts sessions that
* start with a STUN Binding Request (preceded by an optional fake SSL
@ -60,15 +59,7 @@ public abstract class AbstractTcpListener
*/
static void closeNoExceptions(Channel channel)
{
try
{
channel.close();
}
catch (IOException ioe)
{
// The whole idea of the method is to close a specific Channel
// without caring about any possible IOException.
}
MuxServerSocketChannelFactory.closeNoExceptions(channel);
}
/**
@ -82,6 +73,7 @@ public abstract class AbstractTcpListener
private static List<TransportAddress> getLocalAddresses(
int port,
List<NetworkInterface> interfaces)
throws IOException
{
List<TransportAddress> addresses = new LinkedList<>();
@ -107,6 +99,83 @@ public abstract class AbstractTcpListener
return addresses;
}
/**
* Determines whether a specific {@link DatagramPacket} is the first
* expected (i.e. supported) to be received from an accepted
* {@link SocketChannel} by this {@link AbstractTcpListener}. This is true
* if it is contains the hard-coded SSL client handshake (
* {@link GoogleTurnSSLCandidateHarvester#SSL_CLIENT_HANDSHAKE}), or
* a STUN Binding Request.
*
* @param p the {@code DatagramPacket} to examine
* @return {@code true} if {@code p} looks like the first
* {@code DatagramPacket} expected to be received from an accepted
* {@code SocketChannel} by this {@code TcpHarvester};
* otherwise, {@code false}
*/
private static boolean isFirstDatagramPacket(DatagramPacket p)
{
int len = p.getLength();
boolean b = false;
if (len > 0)
{
byte[] buf = p.getData();
int off = p.getOffset();
// Check for Google TURN SSLTCP
final byte[] googleTurnSslTcp
= GoogleTurnSSLCandidateHarvester.SSL_CLIENT_HANDSHAKE;
if (len >= googleTurnSslTcp.length)
{
b = true;
for (int i = 0, iEnd = googleTurnSslTcp.length, j = off;
i < iEnd;
i++, j++)
{
if (googleTurnSslTcp[i] != buf[j])
{
b = false;
break;
}
}
}
// nothing found, lets check for stun binding requests
if (!b)
{
// 2 bytes uint16 length
// STUN Binding request:
// 2 bits 00
// 14 bits STUN Messsage Type
// 2 bytes Message Length
// 4 bytes Magic Cookie
// RFC 5389: For example, a Binding request has class=0b00
// (request) and method=0b000000000001 (Binding) and is encoded
// into the first 16 bits as 0x0001.
if (len >= 10 && buf[off + 2] == 0 && buf[off + 3] == 1)
{
final byte[] magicCookie = Message.MAGIC_COOKIE;
b = true;
for (int i = 0, iEnd = magicCookie.length, j = off + 6;
i < iEnd;
i++, j++)
{
if (magicCookie[i] != buf[j])
{
b = false;
break;
}
}
}
}
}
return b;
}
/**
* The thread which <tt>accept</tt>s TCP connections from the sockets in
* {@link #serverSocketChannels}.
@ -147,6 +216,12 @@ public abstract class AbstractTcpListener
private final List<ServerSocketChannel> serverSocketChannels
= new LinkedList<>();
/**
* The object used to synchronize access to the collection of sessions that
* the implementation of this class uses.
*/
protected final Object sessionsSyncRoot = new Object();
/**
* Initializes a new <tt>TcpHarvester</tt>, which is to
* listen on port number <tt>port</tt> on all IP addresses on all available
@ -208,6 +283,13 @@ public abstract class AbstractTcpListener
protected void addLocalAddresses(List<TransportAddress> transportAddresses)
throws IOException
{
boolean useIPv6 = !StackProperties.getBoolean(
StackProperties.DISABLE_IPv6,
false);
boolean useIPv6LinkLocal = !StackProperties.getBoolean(
StackProperties.DISABLE_LINK_LOCAL_ADDRESSES,
false);
// White list from the configuration
String[] allowedAddressesStr
= StackProperties.getStringArray(StackProperties.ALLOWED_ADDRESSES,
@ -219,7 +301,8 @@ public abstract class AbstractTcpListener
allowedAddresses = new InetAddress[allowedAddressesStr.length];
for (int i = 0; i < allowedAddressesStr.length; i++)
{
allowedAddresses[i] = InetAddress.getByName(allowedAddressesStr[i]);
allowedAddresses[i]
= InetAddress.getByName(allowedAddressesStr[i]);
}
}
@ -249,12 +332,15 @@ public abstract class AbstractTcpListener
continue;
}
if (!config.useIpv6() && (address instanceof Inet6Address))
if (!useIPv6 && (address instanceof Inet6Address))
continue;
if (!config.useLinkLocalAddresses() && address.isLinkLocalAddress())
if (!useIPv6LinkLocal
&& (address instanceof Inet6Address)
&& address.isLinkLocalAddress())
{
logger.info("Not using link-local address " + address +" for TCP candidates.");
logger.info("Not using link-local address " + address +" for"
+ " TCP candidates.");
continue;
}
@ -355,7 +441,21 @@ public abstract class AbstractTcpListener
throws IOException
{
ServerSocketChannel channel = MuxServerSocketChannelFactory
.openAndBindServerSocketChannel(null, address, 0);
.openAndBindMuxServerSocketChannel(
/* properties */ null,
address,
/* backlog */ 0,
new DatagramPacketFilter()
{
/**
* {@inheritDoc}
*/
@Override
public boolean accept(DatagramPacket p)
{
return isFirstDatagramPacket(p);
}
});
serverSocketChannels.add(channel);
}
@ -366,6 +466,8 @@ public abstract class AbstractTcpListener
* @param ufrag the local username fragment for the session.
* @param pushback the first "datagram" (RFC4571-framed), already read from
* the socket's stream.
* @throws IllegalStateException
* @throws IOException
*/
protected abstract void acceptSession(
Socket socket, String ufrag, DatagramPacket pushback)
@ -505,9 +607,7 @@ public abstract class AbstractTcpListener
selector.close();
}
catch (IOException ioe)
{
// ignore
}
{}
}
}
@ -522,6 +622,11 @@ public abstract class AbstractTcpListener
*/
public final SocketChannel channel;
/**
* The time the channel was last found to be active.
*/
long lastActive = System.currentTimeMillis();
/**
* The buffer which stores the data so far read from the channel.
*/
@ -687,8 +792,11 @@ public abstract class AbstractTcpListener
{
/**
* Initializes a new <tt>ReadThread</tt>.
*
* @throws IOException if the selector to be used fails to open.
*/
public ReadThread()
throws IOException
{
setName("TcpHarvester ReadThread");
setDaemon(true);
@ -722,6 +830,50 @@ public abstract class AbstractTcpListener
}
}
/**
* Closes any inactive channels registered with {@link #readSelector}.
* A channel is considered inactive if it hasn't been available for
* reading for
* {@link MuxServerSocketChannelFactory#SOCKET_CHANNEL_READ_TIMEOUT}
* milliseconds.
*/
private void cleanup()
{
long now = System.currentTimeMillis();
for (SelectionKey key : readSelector.keys())
{
// An invalid key specifies that either the channel was closed
// (in which case we do not have to do anything else to it) or
// that we no longer control the channel (i.e. we do not want to
// do anything else to it).
if (!key.isValid())
continue;
ChannelDesc channelDesc = (ChannelDesc) key.attachment();
if (channelDesc == null)
continue;
long lastActive = channelDesc.lastActive;
if (lastActive != -1
&& now - lastActive
> MuxServerSocketChannelFactory
.SOCKET_CHANNEL_READ_TIMEOUT)
{
// De-register from the Selector.
key.cancel();
SocketChannel channel = channelDesc.channel;
logger.info("Read timeout for socket: " + channel.socket());
closeNoExceptions(channel);
}
}
}
/**
* Tries to read, without blocking, from <tt>channel</tt> to its
* buffer. If after reading the buffer is filled, handles the data in
@ -772,6 +924,8 @@ public abstract class AbstractTcpListener
if (read == -1)
throw new IOException("End of stream!");
else if (read > 0)
channel.lastActive = System.currentTimeMillis();
if (!channel.buffer.hasRemaining())
{
@ -957,6 +1111,9 @@ public abstract class AbstractTcpListener
break;
}
// clean up stale channels
cleanup();
checkForNewChannels();
for (SelectionKey key : readSelector.keys())
@ -1016,9 +1173,7 @@ public abstract class AbstractTcpListener
readSelector.close();
}
catch (IOException ioe)
{
// ignore
}
{}
}
}
}

View File

@ -20,18 +20,15 @@ package org.ice4j.ice.harvest;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.ice4j.message.*;
import org.jitsi.utils.queue.*;
import org.ice4j.util.*;
import java.io.*;
import java.net.*;
import java.time.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
import java.util.logging.Logger;
import static org.ice4j.ice.harvest.HarvestConfig.config;
/**
* A class which holds a {@link DatagramSocket} and runs a thread
* ({@link #thread}) which perpetually reads from it.
@ -46,6 +43,14 @@ import static org.ice4j.ice.harvest.HarvestConfig.config;
*/
public abstract class AbstractUdpListener
{
/**
* The name of the property which controls the size of the receive buffer
* which {@link SinglePortUdpHarvester} will request for the sockets that
* it creates.
*/
public static final String SO_RCVBUF_PNAME
= AbstractUdpListener.class.getName() + ".SO_RCVBUF";
/**
* Our class logger.
*/
@ -126,7 +131,10 @@ public abstract class AbstractUdpListener
try
{
Message stunMessage = Message.decode(buf, off, len);
Message stunMessage
= Message.decode(buf,
(char) off,
(char) len);
if (stunMessage.getMessageType()
!= Message.BINDING_REQUEST)
@ -196,51 +204,41 @@ public abstract class AbstractUdpListener
/**
* Initializes a new <tt>SinglePortUdpHarvester</tt> instance which is to
* bind on the specified local address.
* @param localAddress the address to bind to. If the port is 0 an ephemeral port will be chosen by the OS and the
* AbstractUdpListener.localAddress will reflect the allocated port.
* @param localAddress the address to bind to.
* @throws IOException if initialization fails.
*/
protected AbstractUdpListener(TransportAddress localAddress)
throws IOException
{
TransportAddress tempAddress = localAddress;
boolean bindWildcard = StackProperties.getBoolean(
StackProperties.BIND_WILDCARD,
false);
if (bindWildcard)
{
tempAddress = new TransportAddress(
this.localAddress = new TransportAddress(
(InetAddress) null,
localAddress.getPort(),
localAddress.getTransport()
);
}
else
{
this.localAddress = localAddress;
}
socket = new DatagramSocket( tempAddress );
socket = new DatagramSocket( this.localAddress );
Integer receiveBufferSize = config.udpReceiveBufferSize();
if (receiveBufferSize != null)
int receiveBufferSize = StackProperties.getInt(SO_RCVBUF_PNAME, -1);
if (receiveBufferSize > 0)
{
socket.setReceiveBufferSize(receiveBufferSize);
}
/* Update the port number if needed. */
if (localAddress.getPort() == 0)
{
tempAddress = new TransportAddress(
tempAddress.getAddress(),
socket.getLocalPort(),
tempAddress.getTransport()
);
}
this.localAddress = tempAddress;
String logMessage
= "Initialized AbstractUdpListener with address " + this.localAddress;
logMessage += ". Receive buffer size " + socket.getReceiveBufferSize();
if (receiveBufferSize != null)
if (receiveBufferSize > 0)
{
logMessage += " (asked for " + receiveBufferSize + ")";
}
@ -255,16 +253,12 @@ public abstract class AbstractUdpListener
}
};
thread.setName(AbstractUdpListener.class.getName() + " thread for " + this.localAddress);
thread.setName(AbstractUdpListener.class.getName() + " thread for "
+ this.localAddress);
thread.setDaemon(true);
thread.start();
}
public TransportAddress getLocalAddress()
{
return localAddress;
}
/**
* Triggers the termination of the threads of this instance.
*/
@ -397,13 +391,12 @@ public abstract class AbstractUdpListener
*
* @param remoteAddress the remote address with which to associate the new
* socket instance.
* @param ufrag The username fragment associated with the socket.
* @return the created socket instance.
*/
protected MySocket addSocket(InetSocketAddress remoteAddress, String ufrag)
protected MySocket addSocket(InetSocketAddress remoteAddress)
throws SocketException
{
MySocket newSocket = new MySocket(remoteAddress, ufrag);
MySocket newSocket = new MySocket(remoteAddress);
sockets.put(remoteAddress, newSocket);
return newSocket;
}
@ -447,8 +440,6 @@ public abstract class AbstractUdpListener
*/
private boolean closed = false;
private final String ufrag;
/**
* Initializes a new <tt>MySocket</tt> instance with the given
* remote address.
@ -456,17 +447,17 @@ public abstract class AbstractUdpListener
* new instance.
* @throws SocketException
*/
MySocket(InetSocketAddress remoteAddress, String ufrag)
MySocket(InetSocketAddress remoteAddress)
throws SocketException
{
// unbound
super((SocketAddress)null);
this.ufrag = ufrag;
this.remoteAddress = remoteAddress;
if (logger.isLoggable(Level.FINEST))
{
queueStatistics = new QueueStatistics(QUEUE_SIZE, Clock.systemUTC());
queueStatistics = new QueueStatistics(
"SinglePort" + remoteAddress.toString().replace('/', '-'));
}
else
{
@ -486,12 +477,10 @@ public abstract class AbstractUdpListener
// receivers can notice the loss earlier.
if (queue.size() == QUEUE_SIZE)
{
logger.info(
"Dropping a packet because the queue is full. Remote address = "
+ remoteAddress + " ufrag=" + ufrag);
logger.info("Dropping a packet because the queue is full.");
if (queueStatistics != null)
{
queueStatistics.dropped();
queueStatistics.remove(System.currentTimeMillis());
}
queue.poll();
}
@ -499,10 +488,10 @@ public abstract class AbstractUdpListener
queue.offer(buf);
if (queueStatistics != null)
{
queueStatistics.added();
queueStatistics.add(System.currentTimeMillis());
}
queue.notify();
queue.notifyAll();
}
}
@ -637,9 +626,9 @@ public abstract class AbstractUdpListener
}
buf = queue.poll();
if (buf != null && queueStatistics != null)
if (queueStatistics != null)
{
queueStatistics.removed(queue.size(), null);
queueStatistics.remove(System.currentTimeMillis());
}
}
}

View File

@ -83,7 +83,7 @@ public class AwsCandidateHarvester
*/
public AwsCandidateHarvester()
{
super("aws");
super();
}
/**

View File

@ -198,7 +198,7 @@ public class CandidateHarvesterSet
{
try
{
future.get(HarvestConfig.config.timeout().toMillis(), TimeUnit.MILLISECONDS);
future.get(StackProperties.getInt(StackProperties.HARVESTING_TIMEOUT, 15), TimeUnit.SECONDS);
break;
}
catch (TimeoutException te)

View File

@ -26,8 +26,6 @@ import org.ice4j.*;
import org.ice4j.ice.*;
import org.ice4j.socket.*;
import static org.ice4j.ice.harvest.HarvestConfig.config;
/**
* A <tt>HostCandidateHarvester</tt> gathers host <tt>Candidate</tt>s for a
* specified {@link org.ice4j.ice.Component}. Most <tt>CandidateHarvester</tt>s
@ -231,6 +229,13 @@ public class HostCandidateHarvester
public static List<InetAddress> getAllAllowedAddresses()
{
List<InetAddress> addresses = new LinkedList<>();
boolean isIPv6Disabled = StackProperties.getBoolean(
StackProperties.DISABLE_IPv6,
false);
boolean isIPv6LinkLocalDisabled = StackProperties.getBoolean(
StackProperties.DISABLE_LINK_LOCAL_ADDRESSES,
false);
try
{
for (NetworkInterface iface
@ -252,9 +257,11 @@ public class HostCandidateHarvester
if (!isAddressAllowed(address))
continue;
if (!config.useIpv6() && address instanceof Inet6Address)
if (isIPv6Disabled && address instanceof Inet6Address)
continue;
if (!config.useLinkLocalAddresses() && address.isLinkLocalAddress())
if (isIPv6LinkLocalDisabled
&& address instanceof Inet6Address
&& address.isLinkLocalAddress())
continue;
addresses.add(address);
@ -276,8 +283,6 @@ public class HostCandidateHarvester
* If that fails we will move through all ports between <tt>minPort</tt> and
* <tt>maxPort</tt> and give up if still can't find a free port.
*
* If 0, 0, 0 are specified for preferred, min and max port, an ephemeral port will be used instead.
*
* @param component the {@link Component} that we'd like to gather candidate
* addresses for.
* @param preferredPort the port number that should be tried first when
@ -304,11 +309,21 @@ public class HostCandidateHarvester
{
harvestStatistics.startHarvestTiming();
Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
Enumeration<NetworkInterface> interfaces
= NetworkInterface.getNetworkInterfaces();
boolean isIPv6Disabled = StackProperties.getBoolean(
StackProperties.DISABLE_IPv6,
false);
boolean isIPv6LinkLocalDisabled = StackProperties.getBoolean(
StackProperties.DISABLE_LINK_LOCAL_ADDRESSES,
false);
if(transport != Transport.UDP && transport != Transport.TCP)
{
throw new IllegalArgumentException("Transport protocol not supported: " + transport);
throw new IllegalArgumentException(
"Transport protocol not supported: " + transport);
}
boolean boundAtLeastOneSocket = false;
@ -338,20 +353,23 @@ public class HostCandidateHarvester
continue;
}
if (!config.useLinkLocalAddresses() && addr.isLinkLocalAddress())
if (isIPv6LinkLocalDisabled
&& (addr instanceof Inet6Address)
&& addr.isLinkLocalAddress())
{
continue;
}
foundAtLeastOneUsableAddress = true;
if ((addr instanceof Inet4Address) || config.useIpv6())
if((addr instanceof Inet4Address) || !isIPv6Disabled)
{
IceSocketWrapper sock = null;
try
{
if(transport == Transport.UDP)
{
sock = createDatagramSocket(addr, preferredPort, minPort, maxPort);
sock = createDatagramSocket(
addr, preferredPort, minPort, maxPort);
boundAtLeastOneSocket = true;
}
else if(transport == Transport.TCP)
@ -386,8 +404,10 @@ public class HostCandidateHarvester
continue;
}
HostCandidate candidate = new HostCandidate(sock, component, transport);
candidate.setVirtual(NetworkUtils.isInterfaceVirtual(iface));
HostCandidate candidate
= new HostCandidate(sock, component, transport);
candidate.setVirtual(
NetworkUtils.isInterfaceVirtual(iface));
component.addLocalCandidate(candidate);
if (transport == Transport.TCP)
@ -403,7 +423,8 @@ public class HostCandidateHarvester
// them as well while harvesting reflexive candidates.
createAndRegisterStunSocket(candidate);
ComponentSocket componentSocket = component.getComponentSocket();
ComponentSocket componentSocket
= component.getComponentSocket();
if (componentSocket != null)
{
componentSocket.add(sock);
@ -426,7 +447,8 @@ public class HostCandidateHarvester
+ foundAtLeastOneUsableAddress);
}
this.harvestStatistics.stopHarvestTiming(component.getLocalCandidateCount());
this.harvestStatistics
.stopHarvestTiming(component.getLocalCandidateCount());
}
/**
@ -441,7 +463,7 @@ public class HostCandidateHarvester
* <tt>org.ice4j.ice.harvest.BLOCKED_INTERFACES</tt> list. It returns
* <tt>false</tt> otherwise.
*/
public static boolean isInterfaceAllowed(NetworkInterface iface)
static boolean isInterfaceAllowed(NetworkInterface iface)
{
if (iface == null)
throw new IllegalArgumentException("iface cannot be null");
@ -521,8 +543,6 @@ public class HostCandidateHarvester
* <tt>localAddress</tt> and a port in the range specified by the
* <tt>minPort</tt> and <tt>maxPort</tt> parameters.
*
* If 0, 0, 0 are specified for preferred, min and max port, an ephemeral port will be used instead.
*
* @param laddr the address that we'd like to bind the socket on.
* @param preferredPort the port number that we should try to bind to first.
* @param minPort the port number where we should first try to bind before
@ -549,18 +569,7 @@ public class HostCandidateHarvester
BindException
{
// make sure port numbers are valid
boolean ephemeral = checkPorts(preferredPort, minPort, maxPort);
if (ephemeral)
{
ServerSocket socket = new ServerSocket();
socket.setReuseAddress(true);
socket.bind(new InetSocketAddress(laddr, 0));
if (logger.isLoggable(Level.FINEST))
{
logger.finest("Bound using an ephemeral port to " + socket.getLocalSocketAddress());
}
return new IceTcpServerSocketWrapper(new DelegatingServerSocket(socket), component);
}
this.checkPorts(preferredPort, minPort, maxPort);
int bindRetries = StackProperties.getInt(
StackProperties.BIND_RETRIES,
@ -604,7 +613,8 @@ public class HostCandidateHarvester
port = minPort;
}
throw new BindException("Could not bind to any port between " + minPort + " and " + (port - 1));
throw new BindException("Could not bind to any port between "
+ minPort + " and " + (port - 1));
}
/**
@ -619,8 +629,6 @@ public class HostCandidateHarvester
* start over again at <tt>minPort</tt> and keep going until we run out of
* retries.
*
* If 0, 0, 0 are specified for preferred, min and max port, an ephemeral port will be used instead.
*
* @param laddr the address that we'd like to bind the socket on.
* @param preferredPort the port number that we should try to bind to first.
* @param minPort the port number where we should first try to bind before
@ -648,16 +656,7 @@ public class HostCandidateHarvester
BindException
{
// make sure port numbers are valid.
boolean ephemeral = checkPorts(preferredPort, minPort, maxPort);
if (ephemeral)
{
DatagramSocket socket = new MultiplexingDatagramSocket(0, laddr);
if (logger.isLoggable(Level.FINEST))
{
logger.finest("Bound using ephemeral port to " + socket.getLocalSocketAddress());
}
return new IceUdpSocketWrapper(socket);
}
this.checkPorts(preferredPort, minPort, maxPort);
int bindRetries = StackProperties.getInt(
StackProperties.BIND_RETRIES,
@ -719,10 +718,8 @@ public class HostCandidateHarvester
}
/**
* Checks if the different ports are correctly set. If not, throws {@link IllegalArgumentException}. The
* special values 0, 0, 0 for the parameters are interpreted as "use an ephemeral port".
*
* @return {@code true} if the params specify that an ephemeral port should be used, and {@code false} otherwise.
* Checks if the different ports are correctly set. If not, throws an
* IllegalArgumentException.
*
* @param preferredPort the port number that we should try to bind to first.
* @param minPort the port number where we should first try to bind before
@ -734,14 +731,9 @@ public class HostCandidateHarvester
* <tt>maxPort</tt> is not a valid port number or if <tt>minPort</tt> is
* greater than <tt>maxPort</tt>.
*/
private static boolean checkPorts(int preferredPort, int minPort, int maxPort)
private void checkPorts(int preferredPort, int minPort, int maxPort)
throws IllegalArgumentException
{
if (preferredPort == 0 && minPort == 0 && maxPort == 0)
{
return true;
}
// make sure port numbers are valid
if (!NetworkUtils.isValidPortNumber(minPort)
|| !NetworkUtils.isValidPortNumber(maxPort))
@ -766,8 +758,6 @@ public class HostCandidateHarvester
+") must be between minPort (" + minPort
+ ") and maxPort (" + maxPort + ")");
}
return false;
}
/**

View File

@ -0,0 +1,179 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.ice.harvest;
import org.ice4j.*;
import org.ice4j.ice.*;
import java.util.*;
import java.util.logging.*;
/**
* Uses a list of addresses as a predefined static mask in order to generate
* {@link TransportAddress}es. This harvester is meant for use in situations
* where servers are deployed behind a NAT or in a DMZ with static port mapping.
* <p>
* Every time the {@link #harvest(Component)} method is called, the mapping
* harvester will return a list of candidates that provide masked alternatives
* for every host candidate in the component. Kind of like a STUN server.
* <p>
* Example: You run this on a server with address 192.168.0.1, that is behind
* a NAT with public IP: 93.184.216.119. You allocate a host candidate
* 192.168.0.1/UDP/5000. This harvester is going to then generate an address
* 93.184.216.119/UDP/5000
* <p>
* This harvester is instant and does not introduce any harvesting latency.
*
* @author Emil Ivov
*/
public class MappingCandidateHarvester
extends AbstractCandidateHarvester
{
/**
* The <tt>Logger</tt> used by the <tt>StunCandidateHarvester</tt> class and
* its instances for logging output.
*/
private static final Logger logger
= Logger.getLogger(StunCandidateHarvester.class.getName());
/**
* The addresses that we will use as a mask
*/
protected TransportAddress mask;
/**
* The addresses that we will be masking
*/
protected TransportAddress face;
/**
* Creates a mapping harvester with the specified <tt>mask</tt>
*
* @param mask the <tt>TransportAddress</tt>es that would be used as a mask.
* @param face the <tt>TransportAddress</tt>es that we will be masking.
*/
public MappingCandidateHarvester(TransportAddress mask,
TransportAddress face)
{
this.mask = Objects.requireNonNull(mask);
this.face = Objects.requireNonNull(face);
}
/**
* Initializes a {@link MappingCandidateHarvester} instance without
* specified addresses (only useful in subclasses which override
* {@link #getMask()} and {@link #getFace()}).
*/
protected MappingCandidateHarvester()
{
}
/**
* Maps all candidates to this harvester's mask and adds them to
* <tt>component</tt>.
*
* @param component the {@link Component} that we'd like to map candidates
* to.
* @return the <tt>LocalCandidate</tt>s gathered by this
* <tt>CandidateHarvester</tt> or <tt>null</tt> if no mask is specified.
*/
@Override
public Collection<LocalCandidate> harvest(Component component)
{
TransportAddress mask = getMask();
TransportAddress face = getFace();
if (face == null || mask == null)
{
logger.warning("Harvester not configured: face=" + face
+ ", mask=" + mask);
return null;
}
// Report the LocalCandidates gathered by this CandidateHarvester so
// that the harvest is sure to be considered successful.
Collection<LocalCandidate> candidates = new HashSet<>();
for (Candidate<?> cand : component.getLocalCandidates())
{
if (!(cand instanceof HostCandidate)
|| !cand.getTransportAddress().getHostAddress()
.equals(face.getHostAddress())
|| cand.getTransport() != face.getTransport())
{
continue;
}
HostCandidate hostCandidate = (HostCandidate) cand;
TransportAddress mappedAddress = new TransportAddress(
mask.getHostAddress(),
hostCandidate.getHostAddress().getPort(),
hostCandidate.getHostAddress().getTransport());
ServerReflexiveCandidate mappedCandidate
= new ServerReflexiveCandidate(
mappedAddress,
hostCandidate,
hostCandidate.getStunServerAddress(),
CandidateExtendedType.STATICALLY_MAPPED_CANDIDATE);
if (hostCandidate.isSSL())
mappedCandidate.setSSL(true);
//try to add the candidate to the component and then
//only add it to the harvest not redundant
if( !candidates.contains(mappedCandidate)
&& component.addLocalCandidate(mappedCandidate))
{
candidates.add(mappedCandidate);
}
}
return candidates;
}
/**
* Returns the public (mask) address, or null.
* @return the public (mask) address, or null.
*/
public TransportAddress getMask()
{
return mask;
}
/**
* Returns the local (face) address, or null.
* @return the local (face) address, or null.
*/
public TransportAddress getFace()
{
return face;
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
TransportAddress face = getFace();
TransportAddress mask = getMask();
return
this.getClass().getName()
+ ", face=" + (face == null ? "null" : face.getAddress())
+ ", mask=" + (mask == null ? "null" : mask.getAddress());
}
}

View File

@ -16,16 +16,12 @@
package org.ice4j.ice.harvest;
import org.ice4j.*;
import org.jetbrains.annotations.*;
import org.jitsi.utils.concurrent.*;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
import static org.ice4j.ice.harvest.HarvestConfig.config;
/**
* Manages a static list of {@link MappingCandidateHarvester} instances, created
* according to configuration provided as system properties.
@ -41,7 +37,44 @@ public class MappingCandidateHarvesters
* The {@link Logger} used by the {@link MappingCandidateHarvesters}
* class for logging output.
*/
private static final Logger logger = Logger.getLogger(MappingCandidateHarvesters.class.getName());
private static final Logger logger
= Logger.getLogger(MappingCandidateHarvesters.class.getName());
/**
* The name of the property that specifies the local address, if any, for
* the pre-configured NAT harvester.
*/
public static final String NAT_HARVESTER_LOCAL_ADDRESS_PNAME
= "org.ice4j.ice.harvest.NAT_HARVESTER_LOCAL_ADDRESS";
/**
* The name of the property that specifies the public address, if any, for
* the pre-configured NAT harvester.
*/
public static final String NAT_HARVESTER_PUBLIC_ADDRESS_PNAME
= "org.ice4j.ice.harvest.NAT_HARVESTER_PUBLIC_ADDRESS";
/**
* The name of the property used to disable the AWS harvester.
*/
public static final String DISABLE_AWS_HARVESTER_PNAME
= "org.ice4j.ice.harvest.DISABLE_AWS_HARVESTER";
/**
* The name of the property which forces the use of the AWS harvester.
*/
public static final String FORCE_AWS_HARVESTER_PNAME
= "org.ice4j.ice.harvest.FORCE_AWS_HARVESTER";
/**
* The name of the property which contains the addresses of the STUN servers
* to use for the STUN mapping harvester. The property should contain a
* comma-separated list of addresses (pairs of IP address and port,
* separated by a colon). Example:
* {@code stun1.example.com:12345,stun2.example.com:23456}
*/
public static final String STUN_MAPPING_HARVESTER_ADDRESSES_PNAME
= "org.ice4j.ice.harvest.STUN_MAPPING_HARVESTER_ADDRESSES";
/**
* Whether {@link #harvesters} has been initialized.
@ -51,8 +84,7 @@ public class MappingCandidateHarvesters
/**
* The list of already configured harvesters.
*/
private static MappingCandidateHarvester[] harvesters
= new MappingCandidateHarvester[0];
private static MappingCandidateHarvester[] harvesters;
/**
* Whether the discovery of a public address via STUN has failed.
@ -72,21 +104,6 @@ public class MappingCandidateHarvesters
return harvesters;
}
/**
* @return the (first) mapping harvester which matches a given public address, or {@code null} if none match it.
*/
public static MappingCandidateHarvester findHarvesterForAddress(TransportAddress publicAddress)
{
for (MappingCandidateHarvester harvester : harvesters)
{
if (harvester.publicAddressMatches(publicAddress))
{
return harvester;
}
}
return null;
}
/**
* Initializes {@link #harvesters}.
* First it reads the configuration and instantiates harvesters accordingly,
@ -106,48 +123,64 @@ public class MappingCandidateHarvesters
long start = System.currentTimeMillis();
List<MappingCandidateHarvester> harvesterList = new LinkedList<>();
for (HarvestConfig.StaticMapping staticMapping : config.getStaticMappings())
{
logger.info("Adding a static mapping: " + staticMapping);
// If the configuration has no port, then the port value is not used in any way. We put 9 (for "discard")
// as a filler.
int localPort = staticMapping.getLocalPort() != null ? staticMapping.getLocalPort() : 9;
int publicPort = staticMapping.getPublicPort() != null ? staticMapping.getPublicPort() : 9;
TransportAddress localAddress
= new TransportAddress(staticMapping.getLocalAddress(), localPort, Transport.UDP);
TransportAddress publicAddress
= new TransportAddress(staticMapping.getPublicAddress(), publicPort, Transport.UDP);
harvesterList.add(new StaticMappingCandidateHarvester(
publicAddress,
localAddress,
staticMapping.getName(),
staticMapping.getLocalPort() != null));
// Pre-configured NAT harvester.
String localAddressStr
= StackProperties.getString(NAT_HARVESTER_LOCAL_ADDRESS_PNAME);
String publicAddressStr
= StackProperties.getString(NAT_HARVESTER_PUBLIC_ADDRESS_PNAME);
if (localAddressStr != null && publicAddressStr != null)
{
// the port number is unused, 9 is for "discard"
TransportAddress localAddress
= new TransportAddress(localAddressStr, 9, Transport.UDP);
TransportAddress publicAddress
= new TransportAddress(publicAddressStr, 9, Transport.UDP);
harvesterList.add(
new MappingCandidateHarvester(publicAddress, localAddress));
}
// AWS harvester
boolean enableAwsHarvester = config.enableAwsHarvester();
if (enableAwsHarvester && (config.forceAwsHarvester() || AwsCandidateHarvester.smellsLikeAnEC2()))
boolean disableAwsHarvester
= StackProperties.getBoolean(DISABLE_AWS_HARVESTER_PNAME, false);
boolean forceAwsHarvester
= StackProperties.getBoolean(FORCE_AWS_HARVESTER_PNAME, false);
if (logger.isLoggable(Level.FINE))
{
logger.fine("AWS configuration: disable=" + disableAwsHarvester
+ "; force=" + forceAwsHarvester);
}
if (!disableAwsHarvester &&
(forceAwsHarvester || AwsCandidateHarvester.smellsLikeAnEC2()))
{
logger.info("Using AwsCandidateHarvester.");
harvesterList.add(new AwsCandidateHarvester());
}
// STUN harvesters
List<String> stunServers = config.stunMappingCandidateHarvesterAddresses();
if (!stunServers.isEmpty())
String stunServers
= StackProperties.getString(STUN_MAPPING_HARVESTER_ADDRESSES_PNAME);
if (stunServers != null && !stunServers.isEmpty())
{
// Create STUN harvesters (and wait for all of their discovery to finish).
List<StunMappingCandidateHarvester> stunHarvesters = createStunHarvesters(stunServers);
// Create STUN harvesters (and wait for all of their discovery to
// finish).
List<StunMappingCandidateHarvester> stunHarvesters
= createStunHarvesters(stunServers.split(","));
// We have STUN servers configured, so flag failure if none of them were able to discover an address.
// We have STUN servers configured, so flag the failure if none of
// them were able to discover an address.
stunDiscoveryFailed = stunHarvesters.isEmpty();
harvesterList.addAll(stunHarvesters);
}
harvesterList = prune(harvesterList);
harvesters = harvesterList.toArray(new MappingCandidateHarvester[harvesterList.size()]);
harvesters
= harvesterList.toArray(
new MappingCandidateHarvester[harvesterList.size()]);
for (MappingCandidateHarvester harvester : harvesters)
{
@ -196,10 +229,10 @@ public class MappingCandidateHarvesters
for (MappingCandidateHarvester h : harvesters)
{
if (face.getAddress().equals(h.getFace().getAddress())
&& mask.getAddress().equals(h.getMask().getAddress()))
if (face.getAddress().equals(h.getFace().getAddress()) && mask.getAddress().equals(h.getMask().getAddress()))
{
logger.info("Discarding a mapping harvester with duplicate addresses: " + harvester + ". Kept: " + h);
logger.info("Discarding a mapping harvester with duplicate "
+ "addresses: " + harvester + ". Kept: " + h);
return;
}
}
@ -214,20 +247,30 @@ public class MappingCandidateHarvesters
* pairs).
* @return the list of those who were successful in discovering an address.
*/
private static List<StunMappingCandidateHarvester> createStunHarvesters(@NotNull List<String> stunServers)
private static List<StunMappingCandidateHarvester> createStunHarvesters(
String[] stunServers)
{
List<StunMappingCandidateHarvester> stunHarvesters = new LinkedList<>();
if (stunServers == null || stunServers.length == 0)
{
logger.severe("No STUN servers configured.");
return stunHarvesters;
}
List<Callable<StunMappingCandidateHarvester>> tasks = new LinkedList<>();
// Create a StunMappingCandidateHarvester for each local:remote address pair.
List<InetAddress> localAddresses = HostCandidateHarvester.getAllAllowedAddresses();
// Create a StunMappingCandidateHarvester for each local:remote address
// pair.
List<InetAddress> localAddresses
= HostCandidateHarvester.getAllAllowedAddresses();
for (String stunServer : stunServers)
{
String[] addressAndPort = stunServer.split(":");
if (addressAndPort.length < 2)
{
logger.severe("Failed to parse STUN server address: " + stunServer);
logger.severe("Failed to parse STUN server address: "
+ stunServer);
continue;
}
int port;
@ -256,34 +299,33 @@ public class MappingCandidateHarvesters
continue;
}
TransportAddress localAddress = new TransportAddress(localInetAddress, 0, Transport.UDP);
TransportAddress localAddress
= new TransportAddress(localInetAddress, 0, Transport.UDP);
logger.info("Using " + remoteAddress + " for StunMappingCandidateHarvester (localAddress="
+ localAddress + ").");
final StunMappingCandidateHarvester stunHarvester
= new StunMappingCandidateHarvester(localAddress, remoteAddress);
= new StunMappingCandidateHarvester(
localAddress,
remoteAddress);
Callable<StunMappingCandidateHarvester> task = () ->
Callable<StunMappingCandidateHarvester> task
= new Callable<StunMappingCandidateHarvester>()
{
@Override
public StunMappingCandidateHarvester call()
throws Exception
{
stunHarvester.discover();
return stunHarvester;
}
};
tasks.add(task);
}
}
if (tasks.isEmpty())
{
logger.warning("STUN mapping harvesters are configured, but no allowed local addresses were found." +
" Not using STUN.");
return stunHarvesters;
}
// Now run discover() on all created harvesters in parallel and pick
// the ones which succeeded.
ExecutorService es = Executors.newFixedThreadPool(tasks.size());
// Now run discover() on all created harvesters in parallel and pick the ones which succeeded.
ExecutorService es = ExecutorFactory.createFixedThreadPool(tasks.size(), "ice4j.Harvester-executor-");
try
{
List<Future<StunMappingCandidateHarvester>> futures;
try
{
@ -317,11 +359,7 @@ public class MappingCandidateHarvesters
throw new RuntimeException(ie);
}
}
}
finally
{
es.shutdown();
}
return stunHarvesters;
}

View File

@ -101,8 +101,7 @@ public class SinglePortUdpHarvester
/**
* Initializes a new <tt>SinglePortUdpHarvester</tt> instance which is to
* bind on the specified local address.
* @param localAddress the address to bind to. If the port is 0 an ephemeral port is chosen by the OS and the
* SinglePortUdpHarvester.localAddress will reflect the allocated port number.
* @param localAddress the address to bind to.
* @throws IOException if initialization fails.
*/
public SinglePortUdpHarvester(TransportAddress localAddress)
@ -110,7 +109,7 @@ public class SinglePortUdpHarvester
{
super(localAddress);
logger.info("Initialized SinglePortUdpHarvester with address "
+ this.localAddress);
+ localAddress);
}
/**
@ -146,7 +145,7 @@ public class SinglePortUdpHarvester
// 1. Create a socket for this remote address
// 2. Set-up de-multiplexing for future datagrams
// with this address to this socket.
MySocket newSocket = addSocket(remoteAddress, ufrag);
MySocket newSocket = addSocket(remoteAddress);
// 3. Let the candidate and its STUN stack no about the
// new socket.
@ -379,6 +378,7 @@ public class SinglePortUdpHarvester
componentSocket.add(multiplexing);
}
// XXX is this necessary?
synchronized (candidateSockets)
{
IceSocketWrapper oldSocket
@ -403,11 +403,9 @@ public class SinglePortUdpHarvester
@Override
protected IceSocketWrapper getCandidateIceSocketWrapper(
SocketAddress remoteAddress)
{
synchronized (candidateSockets)
{
return candidateSockets.get(remoteAddress);
}
}
}
}

View File

@ -20,13 +20,13 @@ package org.ice4j.ice.harvest;
import org.ice4j.*;
import org.ice4j.socket.*;
import org.ice4j.stunclient.*;
import org.jetbrains.annotations.*;
import java.net.*;
import java.util.logging.*;
/**
* A {@link MappingCandidateHarvester} which uses a STUN servers to discover its public IP address.
* A {@link MappingCandidateHarvester} which uses a STUN servers to discover
* its public IP address.
*
* @author Damian Minkov
* @author Boris Grozev
@ -38,24 +38,13 @@ public class StunMappingCandidateHarvester
* The <tt>Logger</tt> used by the <tt>StunMappingCandidateHarvester</tt>
* class and its instances for logging output.
*/
private static final Logger logger = Logger.getLogger(StunMappingCandidateHarvester.class.getName());
private static final Logger logger
= Logger.getLogger(StunMappingCandidateHarvester.class.getName());
/**
* The list of servers we will use to discover our public address.
*/
private final TransportAddress stunServerAddress;
/**
* The local address this {@link StunMappingCandidateHarvester} was initialized with, and which will be used to
* communicate to STUN servers.
*/
@NotNull
private TransportAddress localAddress;
/**
* The public address discovered through STUN, if any.
*/
private TransportAddress publicAddress = null;
private TransportAddress stunServerAddress;
/**
* Initializes a new {@link StunMappingCandidateHarvester} instance with
@ -66,11 +55,10 @@ public class StunMappingCandidateHarvester
* @param stunServerAddress The address of the STUN server.
*/
public StunMappingCandidateHarvester(
@NotNull TransportAddress localAddress,
TransportAddress localAddress,
TransportAddress stunServerAddress)
{
super("stun");
this.localAddress = localAddress;
face = localAddress;
this.stunServerAddress = stunServerAddress;
}
@ -87,48 +75,22 @@ public class StunMappingCandidateHarvester
= new SimpleAddressDetector(stunServerAddress);
sad.start();
IceSocketWrapper localSocket = new IceUdpSocketWrapper(new DatagramSocket(localAddress));
IceSocketWrapper localSocket
= new IceUdpSocketWrapper(new DatagramSocket(face));
publicAddress = sad.getMappingFor(localSocket);
/* Record bound address as face. */
SocketAddress boundAddr = localSocket.getLocalSocketAddress();
if (boundAddr instanceof InetSocketAddress)
mask = sad.getMappingFor(localSocket);
if (mask != null)
{
localAddress = new TransportAddress((InetSocketAddress)boundAddr, localAddress.getTransport());
}
if (publicAddress != null)
{
logger.info("Discovered public address " + publicAddress
logger.info("Discovered public address " + mask
+ " from STUN server " + stunServerAddress
+ " using local address " + localSocket);
+ " using local address " + face);
}
}
catch (Exception exc)
{
//whatever happens, we just log
logger.log(Level.INFO, "We failed to obtain addresses for the following reason: ", exc);
logger.log(Level.INFO, "We failed to obtain addresses "
+ "for the following reason: ", exc);
}
}
/**
* {@inheritDoc}
*/
@Nullable
@Override
public TransportAddress getFace()
{
return localAddress;
}
/**
* {@inheritDoc}
*/
@Nullable
@Override
public TransportAddress getMask()
{
return publicAddress;
}
}

View File

@ -177,7 +177,7 @@ public class IceSdpUtils
: Connection.IP4;
mediaDescription.setConnection(sdpFactory.createConnection(
"IN", addressFamily, defaultAddress.getHostAddress()));
"IN", defaultAddress.getHostAddress(), addressFamily));
//now check if the RTCP port for the default candidate is different
//than RTP.port +1, in which case we need to mention it.

View File

@ -22,7 +22,6 @@ import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.ice4j.ice.*;
import org.ice4j.stack.*;
/**
@ -470,7 +469,6 @@ public abstract class Message
/* Old TURN attributes */
protected static final byte DESTINATION_ADDRESS_PRESENTITY_INDEX = 29;
// CHECKSTYLE:OFF
protected final static byte attributePresentities[][] = new byte[][]{
// Binding Shared Shared Shared Alloc Alloc Rfrsh Rfrsh ChnlBnd ChnlBnd Send Data
// Binding Binding Error Secret Secret Secret Req. Resp. Req. Resp. Req. Resp. Indic. Indic.
@ -511,7 +509,6 @@ public abstract class Message
/*USE-CANDIDATE*/ { O, N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A},
/*DESTINATION-ADDRESS*/{N_A, N_A, N_A, N_A, N_A, N_A, N_A, N_A, O, N_A, N_A, N_A, M, N_A},
};
// CHECKSTYLE:ON
/**
* Creates an empty STUN Message.
@ -1021,7 +1018,7 @@ public abstract class Message
//add a SOFTWARE attribute if the user said so, and unless they did it
//themselves.
String software = AgentConfig.config.getSoftware();
String software = System.getProperty(StackProperties.SOFTWARE);
if (getAttribute(Attribute.SOFTWARE) == null
&& software != null && software.length() > 0)
@ -1060,11 +1057,11 @@ public abstract class Message
* @throws StunException <tt>ILLEGAL_ARGUMENT</tt> if one or more of the
* arguments have invalid values.
*/
public static Message decode(byte[] binMessage, int offset, int arrayLen)
public static Message decode(byte binMessage[], char offset, char arrayLen)
throws StunException
{
int originalOffset = offset;
arrayLen = Math.min(binMessage.length, arrayLen);
arrayLen = (char)Math.min(binMessage.length, arrayLen);
if(arrayLen - offset < Message.HEADER_LENGTH)
{
@ -1091,7 +1088,7 @@ public abstract class Message
| (binMessage[offset++] & 0xFF));
/* copy the cookie */
byte[] cookie = new byte[4];
byte cookie[] = new byte[4];
System.arraycopy(binMessage, offset, cookie, 0, 4);
offset += 4;
@ -1109,20 +1106,20 @@ public abstract class Message
StunException.ILLEGAL_ARGUMENT,
"The given binary array does not seem to contain"
+ " a whole StunMessage: given "
+ arrayLen
+ ((int) arrayLen)
+ " bytes of "
+ message.getName()
+ " but expecting "
+ (offset + TRANSACTION_ID_LENGTH + length));
}
byte[] tranID = new byte[TRANSACTION_ID_LENGTH];
byte tranID[] = new byte[TRANSACTION_ID_LENGTH];
System.arraycopy(binMessage, offset, tranID, 0, TRANSACTION_ID_LENGTH);
try
{
if(rfc3489Compat)
{
byte[] rfc3489TranID = new byte[TRANSACTION_ID_LENGTH + 4];
byte rfc3489TranID[] = new byte[TRANSACTION_ID_LENGTH + 4];
System.arraycopy(cookie, 0, rfc3489TranID, 0, 4);
System.arraycopy(tranID, 0, rfc3489TranID, 4,
TRANSACTION_ID_LENGTH);

View File

@ -54,8 +54,7 @@ public class MessageFactory
try
{
bindingRequest.setMessageType(Message.BINDING_REQUEST);
}
catch (IllegalArgumentException ex)
} catch (IllegalArgumentException ex)
{
// there should be no exc here since we're the creators.
logger.log(Level.FINE, "Failed to set message type.", ex);
@ -123,8 +122,7 @@ public class MessageFactory
IceControllingAttribute iceControllingAttribute = AttributeFactory
.createIceControllingAttribute(tieBreaker);
bindingRequest.putAttribute(iceControllingAttribute);
}
else
} else
{
IceControlledAttribute iceControlledAttribute = AttributeFactory
.createIceControlledAttribute(tieBreaker);
@ -358,8 +356,7 @@ public class MessageFactory
try
{
allocateRequest.setMessageType(Message.ALLOCATE_REQUEST);
}
catch (IllegalArgumentException ex)
} catch (IllegalArgumentException ex)
{
// there should be no exc here since we're the creators.
logger.log(Level.FINE, "Failed to set message type.", ex);
@ -672,8 +669,7 @@ public class MessageFactory
LifetimeAttribute lifetimeReq = AttributeFactory
.createLifetimeAttribute(lifetime);
refreshRequest.putAttribute(lifetimeReq);
}
catch (IllegalArgumentException ex)
} catch (IllegalArgumentException ex)
{
logger.log(Level.FINE, "Failed to set message type.", ex);
}
@ -953,8 +949,7 @@ public class MessageFactory
.createDataAttribute(data);
sendIndication.putAttribute(dataAttribute);
}
}
catch (IllegalArgumentException ex)
} catch (IllegalArgumentException ex)
{
logger.log(Level.FINE, "Failed to set message type.", ex);
}

View File

@ -387,11 +387,12 @@ public class PseudoTCPBase
}
/**
*
* @return current timestamp limited to 32 bits
*/
public static long now()
{
return (System.nanoTime() / 1000000) & 0xFFFFFFFFL;
return System.currentTimeMillis() & 0xFFFFFFFFL;
}
/**
@ -444,8 +445,7 @@ public class PseudoTCPBase
long nInFlight = m_snd_nxt - m_snd_una;
m_ssthresh = Math.max(nInFlight / 2, 2 * m_mss);
//Logger.Log(LS_INFO)
// << "m_ssthresh: " << m_ssthresh << " nInFlight: " << nInFlight << " m_mss: " << m_mss;
//Logger.Log(LS_INFO) << "m_ssthresh: " << m_ssthresh << " nInFlight: " << nInFlight << " m_mss: " << m_mss;
m_cwnd = m_mss;
// Back off retransmit timer. Note: the limit is lower when connecting.
@ -1252,8 +1252,7 @@ public class PseudoTCPBase
m_recover = m_snd_nxt;
long nInFlight = m_snd_nxt - m_snd_una;
m_ssthresh = Math.max(nInFlight / 2, 2 * m_mss);
//Logger.Log(LS_INFO)
// << "m_ssthresh: " << m_ssthresh << " nInFlight: " << nInFlight << " m_mss: " << m_mss;
//Logger.Log(LS_INFO) << "m_ssthresh: " << m_ssthresh << " nInFlight: " << nInFlight << " m_mss: " << m_mss;
m_cwnd = m_ssthresh + 3 * m_mss;
}
else
@ -1959,7 +1958,7 @@ public class PseudoTCPBase
options_specified.add(kind);
}
if (!options_specified.contains(TCP_OPT_WND_SCALE))
if (options_specified.indexOf(TCP_OPT_WND_SCALE) == -1)//options_specified.size() - 1)
{
logger.log(Level.WARNING, "Peer doesn't support window scaling");
if (getM_rwnd_scale() > 0)

View File

@ -245,7 +245,6 @@ public class PseudoTcpSocket extends Socket
/**
* {@inheritDoc}
*/
@Override
public synchronized void close()
throws IOException
{
@ -257,12 +256,6 @@ public class PseudoTcpSocket extends Socket
}
}
@Override
public OutputStream getOutputStream() throws IOException
{
return socketImpl.getOutputStream();
}
/**
* Allows to set up the remote address directly.
* Otherwise, when using the other <tt>accept</tt> methods,

View File

@ -78,8 +78,15 @@ class PseudoTcpSocketImpl
*/
private long readTimeout;
/**
*
*/
private PseudoTcpInputStream inputStream;
/**
*
*/
private PseudoTcpOutputStream outputstream;
/**
@ -189,7 +196,6 @@ class PseudoTcpSocketImpl
* @param stream if true, create a stream socket; otherwise, create a datagram socket.
* @throws IOException if an I/O error occurs while creating the socket.
*/
@Override
protected void create(boolean stream)
throws IOException
{
@ -202,7 +208,6 @@ class PseudoTcpSocketImpl
* @param port the port number.
* @throws IOException
*/
@Override
protected void connect(String host, int port)
throws IOException
{
@ -215,7 +220,6 @@ class PseudoTcpSocketImpl
* @param port the port number.
* @throws IOException if an I/O error occurs when attempting a connection.
*/
@Override
protected void connect(InetAddress address, int port)
throws IOException
{
@ -230,7 +234,6 @@ class PseudoTcpSocketImpl
* @param timeout the timeout value, in milliseconds, or zero for no timeout.
* @throws IOException if an I/O error occurs when attempting a connection.
*/
@Override
protected void connect(SocketAddress address, int timeout)
throws IOException
{
@ -244,7 +247,6 @@ class PseudoTcpSocketImpl
* @param port the port number.
* @throws IOException
*/
@Override
public void bind(InetAddress host, int port)
throws IOException
{
@ -262,7 +264,6 @@ class PseudoTcpSocketImpl
* @param backlog the maximum length of the queue.
* @throws IOException if an I/O error occurs when creating the queue.
*/
@Override
protected void listen(int backlog)
throws IOException
{
@ -270,7 +271,6 @@ class PseudoTcpSocketImpl
}
private Map<Integer, Object> options = new HashMap<>();
@Override
public void setOption(int optID, Object value)
throws SocketException
{
@ -278,7 +278,6 @@ class PseudoTcpSocketImpl
options.put(optID, value);
}
@Override
public Object getOption(int optID)
throws SocketException
{
@ -335,6 +334,7 @@ class PseudoTcpSocketImpl
*
* @param remoteAddress to which this socket connects to
* @param timeout for this operation in ms
* @throws IOException
*/
void doConnect(InetSocketAddress remoteAddress, long timeout)
throws IOException
@ -355,9 +355,10 @@ class PseudoTcpSocketImpl
while (pseudoTcp.getState() != PseudoTcpState.TCP_ESTABLISHED
&& (noTimeout || (elapsed < timeout)) )
{
long start = System.nanoTime();
long start = System.currentTimeMillis();
state_notify.wait(timeout);
elapsed += TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - start);
long end = System.currentTimeMillis();
elapsed += end - start;
}
if (pseudoTcp.getState() != PseudoTcpState.TCP_ESTABLISHED)
{
@ -430,7 +431,6 @@ class PseudoTcpSocketImpl
* @param s the accepted connection.
* @throws IOException if an I/O error occurs when accepting the connection.
*/
@Override
protected void accept(SocketImpl s)
throws IOException
{
@ -464,7 +464,6 @@ class PseudoTcpSocketImpl
pseudoTcp.notifyClock(PseudoTCPBase.now());
receiveThread = new Thread(new Runnable()
{
@Override
public void run()
{
receivePackets();
@ -484,7 +483,6 @@ class PseudoTcpSocketImpl
* @param tcp the {@link PseudoTCPBase} that caused an event
* @see PseudoTcpNotify#onTcpOpen(PseudoTCPBase)
*/
@Override
public void onTcpOpen(PseudoTCPBase tcp)
{
logger.log(Level.FINE, "tcp opened");
@ -503,7 +501,6 @@ class PseudoTcpSocketImpl
* @param tcp the {@link PseudoTCPBase} that caused an event
* @see PseudoTcpNotify#onTcpReadable(PseudoTCPBase)
*/
@Override
public void onTcpReadable(PseudoTCPBase tcp)
{
if(logger.isLoggable(Level.FINER))
@ -525,7 +522,6 @@ class PseudoTcpSocketImpl
* @param tcp the {@link PseudoTCPBase} that caused an event
* @see PseudoTcpNotify#onTcpWriteable(PseudoTCPBase)
*/
@Override
public void onTcpWriteable(PseudoTCPBase tcp)
{
@ -549,7 +545,6 @@ class PseudoTcpSocketImpl
*
* @see PseudoTcpNotify#onTcpClosed(PseudoTCPBase, IOException)
*/
@Override
public void onTcpClosed(PseudoTCPBase tcp, IOException e)
{
if (e != null)
@ -611,7 +606,6 @@ class PseudoTcpSocketImpl
*
* @see PseudoTcpNotify#tcpWritePacket(PseudoTCPBase, byte[], int)
*/
@Override
public WriteResult tcpWritePacket(PseudoTCPBase tcp, byte[] buffer, int len)
{
if (logger.isLoggable(Level.FINEST))
@ -745,7 +739,13 @@ class PseudoTcpSocketImpl
}
}
private final Runnable clockTaskRunner = this::runClock;
private Runnable clockTaskRunner = new Runnable()
{
@Override
public void run() {
runClock();
}
};
private void scheduleClockTask(long sleep)
{
@ -777,7 +777,6 @@ class PseudoTcpSocketImpl
* @return an output stream for writing to this socket.
* @throws IOException if an I/O error occurs when creating the output stream.
*/
@Override
public OutputStream getOutputStream()
throws IOException
{
@ -794,7 +793,6 @@ class PseudoTcpSocketImpl
* @return a stream for reading from this socket.
* @throws IOException
*/
@Override
public InputStream getInputStream()
throws IOException
{
@ -810,7 +808,6 @@ class PseudoTcpSocketImpl
* @return the number of bytes that can be read from this socket without blocking.
* @throws IOException if an I/O error occurs when determining the number of bytes available.
*/
@Override
protected int available()
throws IOException
{
@ -819,16 +816,16 @@ class PseudoTcpSocketImpl
/**
* Closes this socket.
* @throws IOException
*/
@Override
public void close()
throws IOException
{
try
{
pseudoTcp.close(true);
//System.out.println("ON CLOSE: in flight "+pseudoTcp.getBytesInFlight());
//System.out.println("ON CLOSE: buff not sent "+pseudoTcp.getBytesBufferedNotSent());
//System.out.println("ON CLOSE: in flight "+pseudoTcp.GetBytesInFlight());
//System.out.println("ON CLOSE: buff not sent "+pseudoTcp.GetBytesBufferedNotSent());
onTcpClosed(pseudoTcp, null);
socket.close();
joinAllThreads();
@ -854,7 +851,6 @@ class PseudoTcpSocketImpl
* @param data The byte of data to send
* @throws IOException if there is an error sending the data.
*/
@Override
protected void sendUrgentData(int data)
throws IOException
{
@ -912,7 +908,7 @@ class PseudoTcpSocketImpl
public int read(byte[] buffer, int offset, int length)
throws IOException
{
long start = System.nanoTime();
long start = System.currentTimeMillis();
int read;
while (true)
{
@ -933,7 +929,7 @@ class PseudoTcpSocketImpl
if(readTimeout > 0)
{
//Check for timeout
long elapsed = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - start);
long elapsed = System.currentTimeMillis() - start;
long left = readTimeout - elapsed;
if(left <= 0)
{
@ -1037,6 +1033,12 @@ class PseudoTcpSocketImpl
write(bytes);
}
@Override
public void write(byte[] bytes) throws IOException
{
write(bytes, 0, bytes.length);
}
/**
* This method blocks until all data has been written.
*
@ -1051,7 +1053,7 @@ class PseudoTcpSocketImpl
{
int toSend = length;
int sent;
long start = System.nanoTime();
long start = System.currentTimeMillis();
while (toSend > 0)
{
synchronized (pseudoTcp)
@ -1071,7 +1073,7 @@ class PseudoTcpSocketImpl
{
if(writeTimeout > 0)
{
long elapsed = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - start);
long elapsed = System.currentTimeMillis() - start;
long left = writeTimeout - elapsed;
if(left <= 0)
{
@ -1119,7 +1121,7 @@ class PseudoTcpSocketImpl
public synchronized void flush() throws IOException
{
logger.log(Level.FINE, "Flushing...");
long start = System.nanoTime();
long start = System.currentTimeMillis();
final Object ackNotify = pseudoTcp.getAckNotify();
synchronized (ackNotify)
{
@ -1130,7 +1132,7 @@ class PseudoTcpSocketImpl
if(writeTimeout > 0)
{
//Check write timeout
long elapsed = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - start);
long elapsed = System.currentTimeMillis() - start;
long left = writeTimeout - elapsed;
if(left <= 0)
{
@ -1158,7 +1160,6 @@ class PseudoTcpSocketImpl
@Override
public void close() throws IOException
{
PseudoTcpSocketImpl.this.close();
}
}

View File

@ -755,9 +755,8 @@ public class DelegatingDatagramSocket
p.setAddress(newAddr);
super.send(p);
}
else if (ex instanceof IOException)
{
} else if (ex instanceof IOException) {
throw((IOException)ex);
}
}

View File

@ -18,12 +18,13 @@
package org.ice4j.socket;
import org.ice4j.*;
import org.jitsi.utils.logging2.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
import org.ice4j.util.Logger; //Disambiguation
/**
* A {@link DatagramSocket} implementation which merges a set of sockets.
@ -43,6 +44,14 @@ import java.util.concurrent.*;
public class MergingDatagramSocket
extends DatagramSocket
{
/**
* The {@link Logger} used by the {@link MergingDatagramSocket} class and
* its instances for logging output.
*/
private static final java.util.logging.Logger classLogger
= java.util.logging.Logger.getLogger(
MergingDatagramSocket.class.getName());
/**
* Used to control access to {@link #socketContainers}.
*/
@ -88,7 +97,7 @@ public class MergingDatagramSocket
/**
* The {@link Logger} used by {@link MergingDatagramSocket} instances.
*/
protected final Logger logger;
private final Logger logger;
/**
* Initializes a new {@link MergingDatagramSocket} instance.
@ -102,14 +111,14 @@ public class MergingDatagramSocket
/**
* Initializes a new {@link MergingDatagramSocket} instance.
* @param parentLogger the {@link Logger} parent logger from which we'll
* derive this class' logger instance
* @param levelDelegate the {@link Logger} instance which dictates the
* logging level for the new {@link MergingDatagramSocket} instance.
* @throws SocketException
*/
public MergingDatagramSocket(Logger parentLogger)
public MergingDatagramSocket(Logger levelDelegate)
throws SocketException
{
logger = parentLogger.createChildLogger(this.getClass().getName());
logger = new Logger(classLogger, levelDelegate);
}
/**
@ -211,8 +220,11 @@ public class MergingDatagramSocket
public void add(DelegatingSocket socket)
{
Objects.requireNonNull(socket, "socket");
logger.debug(() -> "Adding a DelegatingSocket instance: "
if (logger.isLoggable(Level.FINE))
{
logger.fine("Adding a DelegatingSocket instance: "
+ socket.getLocalAddress());
}
doAdd(socket);
}
@ -239,8 +251,11 @@ public class MergingDatagramSocket
public void add(DatagramSocket socket)
{
Objects.requireNonNull(socket, "socket");
logger.debug(() -> "Adding a DatagramSocket instance: "
if (logger.isLoggable(Level.FINE))
{
logger.fine("Adding a DatagramSocket instance: "
+ socket.getLocalAddress());
}
doAdd(socket);
}
@ -265,7 +280,7 @@ public class MergingDatagramSocket
{
if (indexOf(socketContainers, socket) != -1)
{
logger.warn("Socket already added.");
logger.warning("Socket already added.");
return;
}
@ -322,7 +337,7 @@ public class MergingDatagramSocket
synchronized (socketContainersSyncRoot)
{
int i = indexOf(socketContainers, socket);
if (i >= 0)
if (i > 0)
{
socketContainer = socketContainers[i];
@ -346,7 +361,7 @@ public class MergingDatagramSocket
if (socketContainer == active)
{
// TODO: proper selection of a new active socket
logger.warn(
logger.warning(
"Removing the active socket. Won't be able to send "
+ "until a new one is elected.");
active = null;
@ -354,13 +369,13 @@ public class MergingDatagramSocket
}
else
{
logger.error("Cannot find socket to remove.");
logger.severe("Cannot find socket to remove.");
}
}
if (logger.isDebugEnabled())
if (logger.isLoggable(Level.FINE))
{
logger.debug("Removed: " + socketContainer);
logger.fine("Removed: " + socketContainer);
}
if (socketContainer != null)
{
@ -580,9 +595,9 @@ public class MergingDatagramSocket
socket = socketWrapper.getUDPSocket();
}
if (logger.isDebugEnabled())
if (logger.isLoggable(Level.FINE))
{
logger.debug("Initializing the active container, socket=" + socket
logger.fine("Initializing the active container, socket=" + socket
+ "; remote address=" + remoteAddress);
}
@ -596,7 +611,7 @@ public class MergingDatagramSocket
// is not necessarily incorrect.
// Still, go on and replace the active socket with whatever
// ICE selected.
logger.warn("Active socket already initialized.");
logger.warning("Active socket already initialized.");
}
SocketContainer newActive = null;
@ -612,7 +627,7 @@ public class MergingDatagramSocket
if (newActive == null)
{
logger.error("No SocketContainer found!");
logger.severe("No SocketContainer found!");
return;
}
@ -727,9 +742,12 @@ public class MergingDatagramSocket
+ getLocalSocketAddress() + " -> "
+ getRemoteSocketAddress());
logger.debug(() -> "Starting the thread for socket "
if (logger.isLoggable(Level.FINE))
{
logger.fine("Starting the thread for socket "
+ getLocalSocketAddress() + " -> "
+ getRemoteSocketAddress());
}
thread.start();
}
@ -779,7 +797,7 @@ public class MergingDatagramSocket
queue.put(buffer);
synchronized (receiveLock)
{
receiveLock.notify();
receiveLock.notifyAll();
}
}
catch (InterruptedException ie)
@ -792,7 +810,10 @@ public class MergingDatagramSocket
// container anymore.
close(true);
logger.debug(() -> "Finished: " + toString());
if (logger.isLoggable(Level.FINE))
{
logger.fine("Finished: " + toString());
}
}
/**
@ -853,7 +874,11 @@ public class MergingDatagramSocket
synchronized (socketContainersSyncRoot)
{
MergingDatagramSocket.this.active = this;
logger.debug(() -> "Switching to new active socket: " + this);
if (logger.isLoggable(Level.FINE))
{
logger.fine("Switching to new active socket: "
+ this);
}
}
}
}

View File

@ -55,8 +55,19 @@ public class MultiplexedDatagramSocket
* The list of <tt>DatagramPacket</tt>s to be received through this
* <tt>DatagramSocket</tt> i.e. accepted by {@link #filter}.
*/
final SocketReceiveBuffer received
= new SocketReceiveBuffer(this::getReceiveBufferSize);
final List<DatagramPacket> received
= new SocketReceiveBuffer()
{
private static final long serialVersionUID
= -5763976093759762087L;
@Override
public int getReceiveBufferSize()
throws SocketException
{
return MultiplexedDatagramSocket.this.getReceiveBufferSize();
}
};
/**
* Initializes a new <tt>MultiplexedDatagramSocket</tt> which is unbound and

View File

@ -67,8 +67,19 @@ public class MultiplexedSocket
* The list of <tt>DatagramPacket</tt>s to be received through this
* <tt>Socket</tt> i.e. accepted by {@link #filter}.
*/
final SocketReceiveBuffer received
= new SocketReceiveBuffer(this::getReceiveBufferSize);
final List<DatagramPacket> received
= new SocketReceiveBuffer()
{
private static final long serialVersionUID
= 678744096057601141L;
@Override
public int getReceiveBufferSize()
throws SocketException
{
return MultiplexedSocket.this.getReceiveBufferSize();
}
};
/**
* Initializes a new <tt>MultiplexedSocket</tt> which is unbound and filters

View File

@ -81,7 +81,7 @@ public class MultiplexingDatagramSocket
* {@inheritDoc}
*/
@Override
protected SocketReceiveBuffer getReceived()
protected List<DatagramPacket> getReceived()
{
return received;
}
@ -90,7 +90,7 @@ public class MultiplexingDatagramSocket
* {@inheritDoc}
*/
@Override
protected SocketReceiveBuffer getReceived(
protected List<DatagramPacket> getReceived(
MultiplexedDatagramSocket socket)
{
return socket.received;
@ -103,8 +103,19 @@ public class MultiplexingDatagramSocket
* {@link MultiplexedDatagramSocket} of this instance at the time of the
* reading from the network.
*/
private final SocketReceiveBuffer received
= new SocketReceiveBuffer(this::getReceiveBufferSize);
private final List<DatagramPacket> received
= new SocketReceiveBuffer()
{
private static final long serialVersionUID
= 3125772367019091216L;
@Override
public int getReceiveBufferSize()
throws SocketException
{
return MultiplexingDatagramSocket.this.getReceiveBufferSize();
}
};
/**
* Buffer variable for storing the SO_TIMEOUT value set by the

View File

@ -92,7 +92,7 @@ public class MultiplexingSocket
* {@inheritDoc}
*/
@Override
protected SocketReceiveBuffer getReceived()
protected List<DatagramPacket> getReceived()
{
return received;
}
@ -101,7 +101,7 @@ public class MultiplexingSocket
* {@inheritDoc}
*/
@Override
protected SocketReceiveBuffer getReceived(
protected List<DatagramPacket> getReceived(
MultiplexedSocket socket)
{
return socket.received;
@ -118,8 +118,19 @@ public class MultiplexingSocket
* <tt>Socket</tt> i.e. not accepted by the <tt>DatagramFilter</tt>s of
* {@link #sockets} at the time of the reading from the network.
*/
private final SocketReceiveBuffer received
= new SocketReceiveBuffer(this::getReceiveBufferSize);
private final List<DatagramPacket> received
= new SocketReceiveBuffer()
{
private static final long serialVersionUID
= 4097024214973676873L;
@Override
public int getReceiveBufferSize()
throws SocketException
{
return MultiplexingSocket.this.getReceiveBufferSize();
}
};
/**
* Buffer variable for storing the SO_TIMEOUT value set by the last

View File

@ -18,9 +18,9 @@
package org.ice4j.socket;
import java.io.*;
import java.lang.reflect.*;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
/**
@ -188,24 +188,6 @@ abstract class MultiplexingXXXSocketSupport
}
}
/**
* The max number of {@link DatagramPacket}'s stored in the receive pool.
*/
private static final int RECEIVE_DATAGRAM_PACKETS_POOL_SIZE = 64;
/**
* The buffer size of pooled datagram packet used to read from
* underlying socket.
*/
private static final int POOLED_DATAGRAM_PACKET_SIZE = 1500;
/**
* A pool of {@link DatagramPacket}s used to receive data from unrelying
* socket.
*/
private final BlockingQueue<DatagramPacket> receiveDatagramPacketsPool
= new ArrayBlockingQueue<>(RECEIVE_DATAGRAM_PACKETS_POOL_SIZE);
/**
* The indicator which determines whether this <tt>DatagramSocket</tt> is
* currently reading from the network using
@ -265,7 +247,7 @@ abstract class MultiplexingXXXSocketSupport
{
if (getFilter(socket).accept(p))
{
SocketReceiveBuffer socketReceived = getReceived(socket);
List<DatagramPacket> socketReceived = getReceived(socket);
synchronized (socketReceived)
{
@ -281,7 +263,7 @@ abstract class MultiplexingXXXSocketSupport
}
if (!accepted)
{
SocketReceiveBuffer thisReceived = getReceived();
List<DatagramPacket> thisReceived = getReceived();
synchronized (thisReceived)
{
@ -370,7 +352,7 @@ abstract class MultiplexingXXXSocketSupport
* not accepted by any (existing) {@code DatagramPacketFilter} at the time of
* receipt
*/
protected abstract SocketReceiveBuffer getReceived();
protected abstract List<DatagramPacket> getReceived();
/**
* Gets the list of {@code DatagramPacket}s received by this multiplexing
@ -383,7 +365,7 @@ abstract class MultiplexingXXXSocketSupport
* socket and accepted by the {@code DatagramPacketFilter} of the
* multiplexed {@code socket} at the time of receipt
*/
protected abstract SocketReceiveBuffer getReceived(
protected abstract List<DatagramPacket> getReceived(
MultiplexedXXXSocketT socket);
/**
@ -488,27 +470,47 @@ abstract class MultiplexingXXXSocketSupport
{
// Pull the packets which have been received already and are accepted by
// the specified multiplexed socket out of the multiplexing socket.
final SocketReceiveBuffer thisReceived = getReceived();
final DatagramPacketFilter socketFilter = getFilter(socket);
final List<DatagramPacket> toMove;
List<DatagramPacket> thisReceived = getReceived();
DatagramPacketFilter socketFilter = getFilter(socket);
List<DatagramPacket> toMove = null;
synchronized (thisReceived)
{
toMove = thisReceived.scan(socketFilter);
if (thisReceived.isEmpty())
{
return;
}
else
{
for (Iterator<DatagramPacket> i = thisReceived.iterator();
i.hasNext();)
{
DatagramPacket p = i.next();
if (socketFilter.accept(p))
{
if (toMove == null)
toMove = new LinkedList<>();
toMove.add(p);
// XXX In the method receive, we allow multiple filters
// to accept one and the same packet.
i.remove();
}
}
}
}
// Push the packets which have been accepted already and are accepted by
// the specified multiplexed socket into the multiplexed socket in
// question.
if (!toMove.isEmpty())
if (toMove != null)
{
final SocketReceiveBuffer socketReceived = getReceived(socket);
List<DatagramPacket> socketReceived = getReceived(socket);
synchronized (socketReceived)
{
for (DatagramPacket datagramPacket : toMove) {
socketReceived.add(datagramPacket);
}
socketReceived.addAll(toMove);
// The notifyAll will practically likely be unnecessary because
// the specified socket will likely be a newly-created one to
// which noone else has a reference. Anyway, dp the invocation
@ -537,11 +539,11 @@ abstract class MultiplexingXXXSocketSupport
* @throws SocketTimeoutException if <tt>timeout</tt> is positive and has
* expired
*/
void receive(SocketReceiveBuffer received, DatagramPacket p, int timeout)
void receive(List<DatagramPacket> received, DatagramPacket p, int timeout)
throws IOException
{
long startTime = System.currentTimeMillis();
DatagramPacket receivedPacket;
DatagramPacket r = null;
do
{
@ -553,10 +555,13 @@ abstract class MultiplexingXXXSocketSupport
// SocketTimeoutException.
synchronized (received)
{
receivedPacket = received.poll();
if (receivedPacket != null)
if (!received.isEmpty())
{
r = received.remove(0);
if (r != null)
break;
}
}
// Throw a SocketTimeoutException if the timeout is over/up.
long remainingTimeout;
@ -617,18 +622,8 @@ abstract class MultiplexingXXXSocketSupport
continue;
}
// The pooled datagram packet instance will be used to receive
// from the network.
DatagramPacket receivePacket
= receiveDatagramPacketsPool.poll();
if (receivePacket == null)
{
receivePacket = new DatagramPacket(
new byte[POOLED_DATAGRAM_PACKET_SIZE],
POOLED_DATAGRAM_PACKET_SIZE);
}
receivePacket.setLength(POOLED_DATAGRAM_PACKET_SIZE);
// The caller will receive from the network.
DatagramPacket c = clone(p, /* arraycopy */ false);
synchronized (receiveSyncRoot)
{
@ -646,11 +641,11 @@ abstract class MultiplexingXXXSocketSupport
}
}
}
doReceive(receivePacket);
doReceive(c);
// The caller received from the network. Copy/add the packet to
// the receive list of the sockets which accept it.
acceptBySocketsOrThis(receivePacket);
acceptBySocketsOrThis(c);
}
finally
{
@ -663,12 +658,7 @@ abstract class MultiplexingXXXSocketSupport
}
while (true);
copy(receivedPacket, p);
// receivePacket is a datagram packet retrieved from SocketReceiveBuffer
// SocketReceiveBuffers only store datagrams borrowed from pool,
// so return datagram back to pool.
receiveDatagramPacketsPool.offer(receivedPacket);
copy(r, p);
}
/**

View File

@ -18,9 +18,11 @@
package org.ice4j.socket;
import java.io.*;
import java.lang.reflect.*;
import java.net.*;
import java.nio.channels.*;
import java.util.*;
import java.util.logging.*;
/**
* If supported by the runtime, initializes {@link ServerSocketChannel}s which
@ -31,6 +33,19 @@ import java.util.*;
*/
public class MuxServerSocketChannelFactory
{
/**
* The {@code Logger} used by the {@code MuxServerSocketChannelFactory}
* class (and its instances) to print debug information.
*/
private static final Logger logger
= Logger.getLogger(MuxServerSocketChannelFactory.class.getName());
/**
* The reflection of the {@code openAndBind} method of the
* {@code MuxServerSocketChannel} class.
*/
private static final Method OPEN_AND_BIND_METHOD;
/**
* The maximum number of milliseconds to wait for an accepted
* {@code SocketChannel} to provide incoming/readable data before it is
@ -41,12 +56,158 @@ public class MuxServerSocketChannelFactory
/**
* The name of the {@code boolean} property of the {@code socket} property
* of the {@code ServerSocketChannel} returned by
* {@link #openAndBindServerSocketChannel(Map, SocketAddress, int)} which
* specifies the value of the {@code SO_REUSEADDR} socket option.
* {@link #openAndBindMuxServerSocketChannel(Map, SocketAddress, int,
* DatagramPacketFilter)} which specifies the value of the
* {@code SO_REUSEADDR} socket option.
*/
public static final String SOCKET_REUSE_ADDRESS_PROPERTY_NAME
= "socket.reuseAddress";
static
{
Class<?> clazz;
try
{
clazz
= Class.forName("org.ice4j.socket.jdk8.MuxServerSocketChannel");
}
catch (ClassNotFoundException cnfex)
{
// The class cannot be located probably because ICE4J was not built
// on JDK 8.
clazz = null;
logger.warning(
"ICE4J does not support sharing of listening endpoints"
+ " (probably because it was not built on JDK 8).");
}
catch (LinkageError lerr)
{
// The linkage fails probably because ICE4J was built on JDK 8 but
// is not run on JDK 8.
clazz = null;
logger.warning(
"ICE4J does not support sharing of listening endpoints"
+ " (probably because it is not running on JDK 8).");
}
Method method;
if (clazz == null)
{
method = null;
}
else
{
try
{
method
= clazz.getDeclaredMethod(
"openAndBind",
Map.class,
SocketAddress.class,
int.class,
DatagramPacketFilter.class);
}
catch (NoSuchMethodException nsmex)
{
throw new RuntimeException(nsmex);
}
}
OPEN_AND_BIND_METHOD = method;
}
/**
* Closes a {@code Channel} and swallows any {@link IOException}.
*
* @param channel the {@code Channel} to close
*/
public static void closeNoExceptions(Channel channel)
{
try
{
channel.close();
}
catch (IOException ioe)
{
// The whole idea of the method is to close a specific Channel
// without caring about any possible IOException.
}
}
/**
* Opens and binds a new {@code MuxServerSocketChannel} instance if
* supported by the runtime. If there are other (existing)
* {@code MuxServerSocketChannel} open and bound on the specified listening
* {@code endpoint}, the new instance will share it with them. If the
* sharing of listening endpoints is not supported by the runtime, falls
* back to {@link #openAndBindServerSocketChannel(Map, SocketAddress, int)}.
*
* @param properties a {@code Map} of the values to be assigned to
* properties of the underlying {@link ServerSocketChannel} which is to
* actually listen on the specified {@code endpoint}. If the new instance is
* not the first to open and bind the specified {@code endpoint}, the
* {@code properties} and their respective values may not be used.
* @param endpoint the IP and port the new instance is to bind to
* @param backlog the requested maximum number of pending incoming
* connections to be queued. If the new instance is not the first to open
* and bind the specified {@code endpoint}, the value may not be used.
* @param filter the {@code DatagramPacketFilter} to demultiplex (i.e.
* recognize) the content meant for the new instance
* @return a new {@code MuxServerSocketChannel} instance open and bound on
* the specified listening {@code endpoint}
* @throws IOException if an I/O error occurs
*/
public static ServerSocketChannel openAndBindMuxServerSocketChannel(
Map<String,Object> properties,
SocketAddress endpoint,
int backlog,
DatagramPacketFilter filter)
throws IOException
{
Method method = OPEN_AND_BIND_METHOD;
if (method == null)
{
return
openAndBindServerSocketChannel(properties, endpoint, backlog);
}
else
{
try
{
return
(ServerSocketChannel)
method.invoke(
null,
properties, endpoint, backlog, filter);
}
catch (IllegalAccessException iaex)
{
IllegalAccessError iaerr
= new IllegalAccessError(iaex.getMessage());
iaerr.initCause(iaex);
throw iaerr;
}
catch (InvocationTargetException itex)
{
Throwable cause = itex.getCause();
if (cause == null)
throw new RuntimeException(itex);
else if (cause instanceof Error)
throw (Error) cause;
else if (cause instanceof IOException)
throw (IOException) cause;
else if (cause instanceof RuntimeException)
throw (RuntimeException) cause;
else
throw new RuntimeException(cause);
}
}
}
/**
* Opens and binds a new {@code ServerSocketChannel} instance.
*
@ -90,7 +251,7 @@ public class MuxServerSocketChannelFactory
else if (value instanceof Boolean)
on = (Boolean) value;
else
on = Boolean.parseBoolean(value.toString());
on = Boolean.valueOf(value.toString());
socket.setReuseAddress(on);
}

View File

@ -19,7 +19,6 @@ package org.ice4j.socket;
import java.io.*;
import java.net.*;
import java.util.concurrent.locks.*;
/**
* Represents a <tt>DatagramSocket</tt> which fixes the following problem: when
@ -30,17 +29,22 @@ import java.util.concurrent.locks.*;
* returns.
*
* @author Lubomir Marinov
* @author Yura Yaroshevich
*/
public class SafeCloseDatagramSocket
extends DelegatingDatagramSocket
{
/**
* A reader-writer lock to prevent {@link #close()} completion if any thread
* is blocked within {@link #receive(DatagramPacket)}.
* The number of {@link #receive(DatagramPacket)} calls that have to return
* before {@link #close()} returns.
*/
private final ReadWriteLock receiveCloseLock
= new ReentrantReadWriteLock();
private int inReceive = 0;
/**
* The <tt>Object</tt> which synchronizes the access to {@link #inReceive}
* and implements the related inter-thread communication.
*/
private final Object inReceiveSyncRoot = new Object();
/**
* Initializes a new <tt>SafeCloseDatagramSocket</tt> instance and binds it
@ -139,10 +143,22 @@ public class SafeCloseDatagramSocket
{
super.close();
final Lock closeLock = receiveCloseLock.writeLock();
closeLock.lock();
// we now know all read threads have finished
closeLock.unlock();
synchronized (inReceiveSyncRoot)
{
boolean interrupted = false;
while (inReceive > 0)
try
{
inReceiveSyncRoot.wait();
}
catch (InterruptedException iex)
{
interrupted = true;
}
if (interrupted)
Thread.currentThread().interrupt();
}
}
/**
@ -166,15 +182,21 @@ public class SafeCloseDatagramSocket
public void receive(DatagramPacket p)
throws IOException
{
final Lock receiveLock = receiveCloseLock.readLock();
receiveLock.lock();
synchronized (inReceiveSyncRoot)
{
inReceive++;
}
try
{
super.receive(p);
}
finally
{
receiveLock.unlock();
synchronized (inReceiveSyncRoot)
{
inReceive--;
inReceiveSyncRoot.notifyAll();
}
}
}
}

View File

@ -19,228 +19,70 @@ package org.ice4j.socket;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
/**
* Implements a buffer of <tt>DatagramPacket</tt>s received by a
* Implements a list of <tt>DatagramPacket</tt>s received by a
* <tt>DatagramSocket</tt> or a <tt>Socket</tt>. The list enforces the
* <tt>SO_RCVBUF</tt> option for the associated <tt>DatagramSocket</tt> or
* <tt>Socket</tt>.
*
* @author Lyubomir Marinov
* @author Yura Yaroshevich
*/
class SocketReceiveBuffer
abstract class SocketReceiveBuffer
extends LinkedList<DatagramPacket>
{
/**
* Default size in bytes of socket receive buffer.
*/
private static final int DEFAULT_RECEIVE_BUFFER_SIZE = 1024 * 1024;
/**
* Maxumum number of datagrams buffer is capable to store regardless
* of total datagram size in bytes.
*/
private static final int DATAGRAMS_BUFFER_CAPACITY = 10000;
private static final long serialVersionUID = 2804762379509257652L;
/**
* Queue to store received datagrams.
*/
private final BlockingQueue<DatagramPacket> buffer
= new ArrayBlockingQueue<>(DATAGRAMS_BUFFER_CAPACITY);
/**
* An instance of datagram size tracker to compute total number of bytes
* stored in datagrams witin {@link #buffer}.
*/
private final DatagramSizeTracker tracker;
/**
* Constructs {@link SocketReceiveBuffer} with user-provided
* @param receiveBufferSizeSupplier a function to obtain receive buffer
* size from associated socket.
*/
public SocketReceiveBuffer(Callable<Integer> receiveBufferSizeSupplier)
{
this.tracker = new DatagramSizeTracker(receiveBufferSizeSupplier);
}
/**
* Check if receive buffer is empty
* @return true if buffer is empty, false - otherwise.
*/
public boolean isEmpty()
{
return buffer.isEmpty();
}
/**
* Adds {@link DatagramPacket} at the end of the socket receive buffer.
* @param p datagram to add into receive buffer
*/
public void add(DatagramPacket p)
{
while (!buffer.offer(p))
{
// ensure buffer capacity restriction enforced
poll();
}
tracker.trackDatagramAdded(p);
while (tracker.isExceedReceiveBufferSize() && buffer.size() > 1)
{
// enforce SO_RCVBUF restriction
poll();
}
}
/**
* Polls socket receive buffer for already stored {@link DatagramPacket}
* @return the first datagram in the buffer, or {@code null} if buffer
* is empty.
*/
public DatagramPacket poll()
{
DatagramPacket p = buffer.poll();
// Keep track of the (total) size in bytes of this receive buffer in
// order to be able to enforce SO_RCVBUF restriction.
if (p != null)
{
tracker.trackDatagramRemoved(p);
}
return p;
}
/**
* Scans buffer of received {@link DatagramPacket}s and move
* datagrams which matches the {@code filter} into returned list.
* @param filter a predicate to filter {@link DatagramPacket} stored
* in receive buffer.
* @return list of datagrams matched to {@code filter}.
*/
public List<DatagramPacket> scan(DatagramPacketFilter filter)
{
List<DatagramPacket> matchedDatagrams = null;
final Iterator<DatagramPacket> it = buffer.iterator();
while (it.hasNext())
{
final DatagramPacket p = it.next();
if (filter.accept(p))
{
if (matchedDatagrams == null)
{
matchedDatagrams = new ArrayList<>();
}
matchedDatagrams.add(p);
it.remove();
tracker.trackDatagramRemoved(p);
}
}
if (matchedDatagrams != null)
{
return matchedDatagrams;
}
return Collections.emptyList();
}
/**
* A helper class to keep track of total size in bytes of all
* {@link DatagramPacket} instances stored in {@link #buffer} to
* be able to enforce SO_RCVBUF.
*/
private final class DatagramSizeTracker
{
/**
* The value of the <tt>SO_RCVBUF</tt> option for the associated
* <tt>DatagramSocket</tt> or <tt>Socket</tt>. Cached for the sake of
* performance.
*/
private int cachedReceiveBufferSize;
private int receiveBufferSize;
/**
* The (total) size in bytes of this receive buffer.
*/
private int totalBuffersByteSize;
private int size;
/**
* Counts total number of datagrams added to buffer.
* {@inheritDoc}
*/
private int totalDatagramsAdded;
/**
* A user provided getter of receive buffer size, might
* fail with {@link Exception} when called.
*/
private final Callable<Integer> receiveBufferSizeSupplier;
/**
* Create a tracker of datagram packet size stored in buffer.
* @param receiveBufferSizeSupplier a function to obtain receive buffer
* size from associated socket.
*/
public DatagramSizeTracker(
Callable<Integer> receiveBufferSizeSupplier)
@Override
public boolean add(DatagramPacket p)
{
this.receiveBufferSizeSupplier = receiveBufferSizeSupplier;
}
boolean added = super.add(p);
/**
* Check if total bytes stored in {@link #buffer} exceeds socket's
* receive buffer size.
* @return true if size exceeded, false - otherwise
*/
boolean isExceedReceiveBufferSize()
// Keep track of the (total) size in bytes of this receive buffer in
// order to be able to enforce SO_RCVBUF.
if (added && (p != null))
{
return totalBuffersByteSize > cachedReceiveBufferSize;
}
int pSize = p.getLength();
/**
* Updates computed value of total datagrams size in bytes
* stored in {@link #buffer} with datagram just added to buffer.
* @param p datagram packed added to {@link #buffer}
*/
void trackDatagramAdded(DatagramPacket p)
if (pSize > 0)
{
++totalDatagramsAdded;
final int pSize = p.getLength();
if (pSize <= 0)
{
return;
}
totalBuffersByteSize += pSize;
size += pSize;
// If the added packet is the only element of this list, do not
// drop it because of the enforcement of SO_RCVBUF.
if (buffer.size() > 1)
if (size() > 1)
{
// For the sake of performance, do not invoke the method
// getReceiveBufferSize() of DatagramSocket or Socket on
// every packet added to this buffer.
int receiveBufferSize = this.cachedReceiveBufferSize;
int receiveBufferSize = this.receiveBufferSize;
if ((receiveBufferSize <= 0)
|| (totalDatagramsAdded % 1000 == 0))
if ((receiveBufferSize <= 0) || (modCount % 1000 == 0))
{
try
{
receiveBufferSize
= this.receiveBufferSizeSupplier.call();
receiveBufferSize = getReceiveBufferSize();
}
catch (Exception e)
catch (SocketException sex)
{
// nothing to do
}
if (receiveBufferSize <= 0)
{
receiveBufferSize = DEFAULT_RECEIVE_BUFFER_SIZE;
@ -259,29 +101,50 @@ class SocketReceiveBuffer
= DEFAULT_RECEIVE_BUFFER_SIZE;
}
}
this.cachedReceiveBufferSize = receiveBufferSize;
this.receiveBufferSize = receiveBufferSize;
}
if (size > receiveBufferSize)
remove(0);
}
}
}
return added;
}
/**
* Updates computed value of total datagrams size in bytes
* stored in {@link #buffer} with datagram just removed from buffer.
* @param p datagram packed removed from {@link #buffer}
* Gets the value of the <tt>SO_RCVBUF</tt> option for the associated
* <tt>DatagramSocket</tt> or <tt>Socket</tt> which is the buffer size used
* by the platform for input on the <tt>DatagramSocket</tt> or
* <tt>Socket</tt>.
*
* @return the value of the <tt>SO_RCVBUF</tt> option for the associated
* <tt>DatagramSocket</tt> or <tt>Socket</tt>
* @throws SocketException if there is an error in the underlying protocol
*/
void trackDatagramRemoved(DatagramPacket p)
{
final int pSize = p.getLength();
if (pSize <= 0)
{
return;
}
public abstract int getReceiveBufferSize()
throws SocketException;
totalBuffersByteSize -= pSize;
if (totalBuffersByteSize < 0)
/**
* {@inheritDoc}
*/
@Override
public DatagramPacket remove(int index)
{
totalBuffersByteSize = 0;
DatagramPacket p = super.remove(index);
// Keep track of the (total) size in bytes of this receive buffer in
// order to be able to enforce SO_RCVBUF.
if (p != null)
{
int pSize = p.getLength();
if (pSize > 0)
{
size -= pSize;
if (size < 0)
size = 0;
}
}
return p;
}
}

View File

@ -0,0 +1,79 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.net.*;
import java.nio.*;
/**
* Associates a {@link ByteBuffer} with a {@link DatagramPacket} so that the
* {@code ByteBuffer} may be used for writing into a {@code byte} array and the
* {@code DatagramPacket} may be used for reading from the same {@code byte}
* array.
*
* @author Lyubomir Marinov
*/
class DatagramBuffer
extends Timestamped<ByteBuffer>
{
/**
* The {@code DatagramPacket} which is associated with the
* {@link ByteBuffer} {@link #o} and shares its {@code data} with.
*/
private final DatagramPacket datagramPacket;
/**
* Initializes a new {@code DatagramBuffer} instance with a specific
* capacity of {@code byte}s shared between a {@code ByteBuffer} and a
* {@code DatagramPacket}.
*
* @param capacity the maximum number of {@code byte}s to be written into
* and read from the new instance
*/
public DatagramBuffer(int capacity)
{
super(ByteBuffer.allocate(capacity));
datagramPacket
= new DatagramPacket(o.array(), /* offset */ 0, /* length */ 0);
}
/**
* Gets the {@code ByteBuffer} (view) of this instance.
*
* @return the {@code ByteBuffer} (view) of this instance
*/
public ByteBuffer getByteBuffer()
{
return o;
}
/**
* Gets the {@code DatagramPacket} (view) of this instance. The
* {@code length} of the {@code DatagramPacket} equals the {@code position}
* of the {@code ByteBuffer} so that the {@code byte}s written into the
* {@code ByteBuffer} may be read from the {@code DatagramPacket}.
*
* @return the {@code DatagramPacket} (view) of this instance
*/
public DatagramPacket getDatagramPacket()
{
datagramPacket.setLength(getByteBuffer().position());
return datagramPacket;
}
}

View File

@ -0,0 +1,125 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.io.*;
import java.nio.channels.*;
import org.ice4j.socket.*;
import sun.nio.ch.*;
/**
* Implements a {@code ServerSocketChannel} which delegates (its method calls)
* to another {@code ServerSocketChannel}. In other words, the former wraps the
* latter.
*
* @author Lyubomir Marinov
*/
class DelegatingServerSocketChannel<T extends ServerSocketChannel>
extends BaseDelegatingServerSocketChannel<T>
implements SelChImpl
{
/**
* The view of {@link #delegate} as a <tt>SelChImpl</tt> interface instance
* required by {@link Selector} and related functionality.
*/
protected final SelChImpl delegateAsSelChImpl;
/**
* Initializes a new {@code DelegatingServerSocketChannel} instance which is
* to delegate (its method calls) to a specific {@code ServerSocketChannel}.
*
* @param delegate the {@code ServerSocketChannel} the new instance is to
* delegate (its method calls) to
*/
public DelegatingServerSocketChannel(T delegate)
{
super(delegate);
delegateAsSelChImpl
= (delegate instanceof SelChImpl) ? (SelChImpl) delegate : null;
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public FileDescriptor getFD()
{
return delegateAsSelChImpl.getFD();
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public int getFDVal()
{
return delegateAsSelChImpl.getFDVal();
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public void kill()
throws IOException
{
delegateAsSelChImpl.kill();
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public void translateAndSetInterestOps(int ops, SelectionKeyImpl sk)
{
delegateAsSelChImpl.translateAndSetInterestOps(ops, sk);
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public boolean translateAndSetReadyOps(int ops, SelectionKeyImpl sk)
{
return delegateAsSelChImpl.translateAndSetReadyOps(ops, sk);
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public boolean translateAndUpdateReadyOps(int ops, SelectionKeyImpl sk)
{
return delegateAsSelChImpl.translateAndUpdateReadyOps(ops, sk);
}
}

View File

@ -0,0 +1,124 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.io.*;
import java.nio.channels.*;
import org.ice4j.socket.*;
import sun.nio.ch.*;
/**
* Implements a {@code SocketChannel} which delegates (its method calls) to
* another {@code SocketChannel}. In other words, the former wraps the latter.
*
* @author Lyubomir Marinov
*/
class DelegatingSocketChannel<T extends SocketChannel>
extends BaseDelegatingSocketChannel<T>
implements SelChImpl
{
/**
* The view of {@link #delegate} as a <tt>SelChImpl</tt> interface instance
* required by {@link Selector} and related functionality.
*/
protected final SelChImpl delegateAsSelChImpl;
/**
* Initializes a new {@code DelegatingSocketChannel} instance which is to
* delegate (its method calls) to a specific {@code SocketChannel}.
*
* @param delegate the {@code SocketChannel} the new instance is to delegate
* (its method calls) to
*/
public DelegatingSocketChannel(T delegate)
{
super(delegate);
delegateAsSelChImpl
= (delegate instanceof SelChImpl) ? (SelChImpl) delegate : null;
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public FileDescriptor getFD()
{
return delegateAsSelChImpl.getFD();
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public int getFDVal()
{
return delegateAsSelChImpl.getFDVal();
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public void kill()
throws IOException
{
delegateAsSelChImpl.kill();
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public void translateAndSetInterestOps(int ops, SelectionKeyImpl sk)
{
delegateAsSelChImpl.translateAndSetInterestOps(ops, sk);
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public boolean translateAndSetReadyOps(int ops, SelectionKeyImpl sk)
{
return delegateAsSelChImpl.translateAndSetReadyOps(ops, sk);
}
/**
* {@inheritDoc}
*
* Forwards to {@link #delegate}.
*/
@Override
public boolean translateAndUpdateReadyOps(int ops, SelectionKeyImpl sk)
{
return delegateAsSelChImpl.translateAndUpdateReadyOps(ops, sk);
}
}

View File

@ -0,0 +1,56 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.io.*;
import java.net.*;
import java.util.*;
import org.ice4j.socket.*;
/**
* Represents a {@link ServerSocket} associated with a
* {@code MuxServerSocketChannel}.
*
* @author Lyubomir Marinov
*/
class MuxServerSocket
extends DelegatingServerSocket
{
/**
* Initializes a new {@code MuxServerSocket} instance which delegates (its
* method calls) to a specific {@code MuxingServerSocket} and is associated
* with a specific {@code MuxServerSocketChannel}.
*
* @param delegate the {@code MuxingServerSocket} the new instance is to
* delegate (its method calls) to. Technically, it is the {@code socket} of
* the {@code delegate} of {@code channel}.
* @param channel the {@code MuxServerSocketChannel} associated with the new
* instance
* @throws IOException if an I/O error occurs
*/
public MuxServerSocket(
MuxingServerSocket delegate,
MuxServerSocketChannel channel)
throws IOException
{
super(
Objects.requireNonNull(delegate, "delegate"),
Objects.requireNonNull(channel, "channel"));
}
}

View File

@ -0,0 +1,298 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.io.*;
import java.net.*;
import java.nio.channels.*;
import java.util.*;
import org.ice4j.socket.*;
/**
* Implements a {@link ServerSocketChannel} which is capable of sharing its
* listening endpoint with multiple others like it.
*
* @author Lyubomir Marinov
*/
public class MuxServerSocketChannel
extends DelegatingServerSocketChannel<MuxingServerSocketChannel>
{
/**
* Opens and binds a new {@code MuxServerSocketChannel} instance. If there
* are other (existing) {@code MuxServerSocketChannel} open and bound on the
* specified listening {@code endpoint}, the new instance will share it with
* them.
*
* @param properties a {@code Map} of the values to be assigned to
* properties of the underlying {@link ServerSocketChannel} which is to
* actually listen on the specified {@code endpoint}. If the new instance is
* not the first to open and bind the specified {@code endpoint}, the
* {@code properties} and their respective values may not be used.
* @param endpoint the IP and port the new instance is to bind to
* @param backlog the requested maximum number of pending incoming
* connections to be queued. If the new instance is not the first to open
* and bind the specified {@code endpoint}, the value may not be used.
* @param filter the {@code DatagramPacketFilter} to demultiplex (i.e.
* recognize) the content meant for the new instance
* @return a new {@code MuxServerSocketChannel} instance open and bound on
* the specified listening {@code endpoint}
* @throws IOException if an I/O error occurs
*/
public static MuxServerSocketChannel openAndBind(
Map<String,Object> properties,
SocketAddress endpoint,
int backlog,
DatagramPacketFilter filter)
throws IOException
{
return
MuxingServerSocketChannel.openAndBind(
properties,
endpoint,
backlog,
filter);
}
/**
* The (ordered) list (i.e. queue) of <tt>SocketChannel</tt>s to be returned
* by {@link #accept()}.
*/
private final Queue<Timestamped<SocketChannel>> acceptQ
= new LinkedList<>();
/**
* The {@code DatagramPacketFilter} which demultiplexes
* {@code SocketChannel}s accepted by the associated
* {@code MuxingServerSocketChannel}.
*/
protected final DatagramPacketFilter filter;
/**
* The <tt>Object</tt> which synchronizes the access to the state of this
* <tt>MuxServerSocketChannel</tt> such as {@link #acceptQ}.
*/
private final Object syncRoot = new Object();
/**
* Initializes a new {@code MuxServerSocketChannel} instance which is to
* demultiplex {@link SocketChannel}s accepted by a specific
* {@link MuxingServerSocketChannel} using a specific
* {@link DatagramPacketFilter}. The new instance shares the listening
* endpoint of {@code delegate} with any other associated
* {@code MuxServerSocketChannel}s.
*
* @param delegate the {@code MuxingServerSocketChannel} which is actually
* open and bound to a listening endpoint and accepts {@code SocketChannel}s
* to be filtered by associated
* {@code MuxServerSocketChannel}s
* @param filter the {@code DatagramPacketFilter} which is to demultiplex
* {@code SocketChannel}s accepted by {@code delegate}
*/
protected MuxServerSocketChannel(
MuxingServerSocketChannel delegate,
DatagramPacketFilter filter)
{
super(Objects.requireNonNull(delegate, "delegate"));
this.filter = Objects.requireNonNull(filter, "filter");
}
/**
* {@inheritDoc}
*/
@Override
public SocketChannel accept()
throws IOException
{
SocketChannel accepted = null;
boolean interrupted = false;
// Pop a SocketChannel from acceptQ.
try
{
do
{
if (!isOpen())
{
throw new ClosedChannelException();
}
else if (!isBound())
{
throw new NotYetBoundException();
}
else
{
synchronized (syncRoot)
{
Timestamped<SocketChannel> timestamped = acceptQ.poll();
if (timestamped == null)
{
if (isBlocking())
{
try
{
syncRoot.wait();
}
catch (InterruptedException ie)
{
interrupted = true;
}
}
else
{
break;
}
}
else if ((accepted = timestamped.o).isOpen())
{
// Allow the MuxServerSocketChannel class and/or its
// super(s) to have a final say on the accepted
// SocketChannel such as wrapping it into a suitable
// specialization of DelegatingSocketChannel.
accepted = implAccept(accepted);
if (accepted != null)
break;
}
}
}
}
while (true);
}
finally
{
// Restore the interrupted state of the current thread if we've
// cleared it in the loop above.
if (interrupted)
Thread.currentThread().interrupt();
}
return accepted;
}
/**
* Weeds out abandoned {@code SocketChannels} from {@link #acceptQ} i.e.
* which were classified/filtered into this {@code MuxServerSocketChannel}
* but were not accepted (out of it) for a long time.
*
* @param now the (system) time in milliseconds at which the method is
* invoked
*/
void closeAbandonedSocketChannels(long now)
{
synchronized (syncRoot)
{
Collection<Timestamped<SocketChannel>> chs = acceptQ;
if (!chs.isEmpty())
{
for (Iterator<Timestamped<SocketChannel>> i = chs.iterator();
i.hasNext();)
{
Timestamped<SocketChannel> ch = i.next();
if (now - ch.timestamp
>= MuxingServerSocketChannel
.SOCKET_CHANNEL_READ_TIMEOUT)
{
i.remove();
MuxingServerSocketChannel.closeNoExceptions(ch.o);
}
}
}
}
}
/**
* Determines whether the {@link #filter} of this instance accepts a
* specific {@code SocketChannel} from which a specific
* {@code DatagramPacket} has been read and, if it does, queues the
* {@code channel} to be accepted through this instance.
*
* @param p the {@code DatagramPacket} which has been read from
* {@code channel} and which is to be analyzed by the {@code filter} of this
* instance
* @param channel the {@code SocketChannel} from which {@code p} has been
* read and which is to be queued for acceptance through this instance if
* the {@code filter} accepts {@code p}
* @return {@code true} if the {@code filter} of this instance accepts
* {@code p} and {@code channel} was queued for acceptance through this
* instance; otherwise, {@code false}
*/
protected boolean filterAccept(DatagramPacket p, SocketChannel channel)
{
return
filter.accept(p) && qAccept(new PreReadSocketChannel(p, channel));
}
/**
* {@inheritDoc}
*
* Adjusts the blocking mode of {@link #delegate}.
*/
@Override
protected void implConfigureBlocking(boolean block)
throws IOException
{
// If at least one MuxServerSocketChannel is configured as non-blocking,
// then MuxingServerSocketChannel has to be configured as non-blocking
// as well.
if (!block)
delegate.configureBlocking(block);
}
/**
* {@inheritDoc}
*
* Associates a {@link MuxServerSocket} with this
* {@code MuxServerSocketChannel}.
*/
@Override
protected MuxServerSocket implSocket(ServerSocket socket)
throws IOException
{
return new MuxServerSocket((MuxingServerSocket) socket, this);
}
/**
* Queues a {@link SocketChannel} for acceptance through this instance.
*
* @param channel the {@code SocketChannel} to queue for acceptance through
* this instance
* @return {@code true} if {@code channel} was queued for acceptance through
* this instance; otherwise, {@code false}
*/
boolean qAccept(SocketChannel channel)
{
boolean b;
synchronized (syncRoot)
{
if (acceptQ.offer(
new Timestamped<>(channel, System.currentTimeMillis())))
{
syncRoot.notifyAll();
b = true;
}
else
{
b = false;
}
}
return b;
}
}

View File

@ -0,0 +1,56 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.io.*;
import java.net.*;
import java.util.*;
import org.ice4j.socket.*;
/**
* Represents a {@link ServerSocket} associated with a
* {@code MuxingServerSocketChannel}.
*
* @author Lyubomir Marinov
*/
class MuxingServerSocket
extends DelegatingServerSocket
{
/**
* Initializes a new {@code MuxingServerSocket} instance which delegates
* (its method calls) to a specific {@code ServerSocket} and is associated
* with a specific {@code MuxingServerSocketChannel}.
*
* @param delegate the {@code ServerSocket} the new instance is to delegate
* (its method calls) to. Technically, it is the {@code socket} of the
* {@code delegate} of {@code channel}.
* @param channel the {@code MuxingServerSocketChannel} associated with the
* new instance
* @throws IOException if an I/O error occurs
*/
public MuxingServerSocket(
ServerSocket delegate,
MuxingServerSocketChannel channel)
throws IOException
{
super(
Objects.requireNonNull(delegate, "delegate"),
Objects.requireNonNull(channel, "channel"));
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,108 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
import java.io.*;
import java.net.*;
import java.nio.*;
import java.nio.channels.*;
/**
* Prepends a {@link DatagramPacket} to a {@link SocketChannel}. In other words,
* enables looking ahead at the {@code byte}s of a {@code SocketChannel}.
*
* @author Lyubomir Marinov
*/
class PreReadSocketChannel
extends DelegatingSocketChannel<SocketChannel>
{
/**
* The {@link DatagramPacket} which is to be prepended to the
* {@link SocketChannel} which is the {@link #delegate} of this
* {@link DelegatingSocketChannel}.
*/
private final DatagramPacket preRead;
/**
* Initializes a new {@code PreReadSocketChannel} instance which is to
* prepend a specific {@link DatagramPacket} to a specific
* {@link SocketChannel}.
*
* @param preRead the {@code DatagramPacket} to prepend to {@code delegate}
* @param delegate the {@code SocketChannel} to prepend {@code preRead} to
*/
public PreReadSocketChannel(DatagramPacket preRead, SocketChannel delegate)
{
super(delegate);
this.preRead = preRead;
}
/**
* {@inheritDoc}
*
* Reads from {@link #preRead} first (until it is fully read) and then
* continues with the {@code super} implementation.
*/
@Override
public int read(ByteBuffer dst)
throws IOException
{
synchronized (preRead)
{
int len = preRead.getLength();
int read;
if (len > 0)
{
int toRead = Math.min(len, dst.remaining());
if (toRead > 0)
{
byte[] buf = preRead.getData();
int off = preRead.getOffset();
dst.put(buf, off, toRead);
read = toRead;
preRead.setData(buf, off + read, len - read);
}
else
{
read = 0;
}
}
else
{
read = 0;
}
if (read == 0)
{
read = super.read(dst);
}
else if (dst.hasRemaining())
{
int superRead = super.read(dst);
if (superRead > 0)
read += superRead;
}
return read;
}
}
}

View File

@ -0,0 +1,66 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.socket.jdk8;
/**
* Represents an {@code Object} with a timestamp.
*
* @param <T> the type of the {@code Object} which has a timestamp (associated)
* @author Lyubomir Marinov
*/
class Timestamped<T>
{
/**
* The {@code Object} associated with {@link #timestamp}.
*/
final T o;
/**
* The timestamp (in milliseconds) associated with {@link #o}.
*/
long timestamp;
/**
* Initializes a new {@code Timestamped} instance with a specific
* {@code Object} and a default timestamp (value).
*
* @param o the {@code Object} to associate with a timestamp
*/
public Timestamped(T o)
{
this(o, -1);
}
/**
* Initializes a new {@code Timestamped} instance with a specific
* {@code Object} and a specific timestamp (value).
*
* @param o the {@code Object} to associate with {@code timestamp}
* @param timestamp the timestamp (in milliseconds) to associate with
* {@code o}
*/
public Timestamped(T o, long timestamp)
{
// It makes no sense to associate a timestamp with a null.
if (o == null)
throw new NullPointerException("o");
this.o = o;
this.timestamp = timestamp;
}
}

View File

@ -20,7 +20,7 @@ package org.ice4j.stack;
import java.io.*;
import java.net.*;
import java.nio.channels.*;
import java.util.function.*;
import java.util.concurrent.*;
import java.util.logging.*;
import org.ice4j.*;
@ -29,9 +29,8 @@ import org.ice4j.socket.*;
/**
* The Network Access Point is the most outward part of the stack. It is
* constructed around a datagram socket and takes care of forwarding incoming
* messages to the provided {@link #messageConsumer} as well as sending
* datagrams to the STUN server specified by the
* original NetAccessPointDescriptor.
* messages to the MessageProcessor as well as sending datagrams to the STUN
* server specified by the original NetAccessPointDescriptor.
*
* @author Emil Ivov
*/
@ -45,9 +44,9 @@ class Connector
= Logger.getLogger(Connector.class.getName());
/**
* The consumer of incoming <tt>RawMessage</tt>s
* The message queue is where incoming messages are added.
*/
private final Consumer<RawMessage> messageConsumer;
private final BlockingQueue<RawMessage> messageQueue;
/**
* The socket object that used by this access point to access the network.
@ -88,16 +87,16 @@ class Connector
* communication.
* @param remoteAddress the remote address of the socket of this
* {@link Connector} if it is a TCP socket, or null if it is UDP.
* @param messageConsumer the incoming messages consumer
* @param messageQueue the Queue where incoming messages should be queued
* @param errorHandler the instance to notify when errors occur.
*/
protected Connector(IceSocketWrapper socket,
TransportAddress remoteAddress,
Consumer<RawMessage> messageConsumer,
BlockingQueue<RawMessage> messageQueue,
ErrorHandler errorHandler)
{
this.sock = socket;
this.messageConsumer = messageConsumer;
this.messageQueue = messageQueue;
this.errorHandler = errorHandler;
this.remoteAddress = remoteAddress;
@ -210,8 +209,7 @@ class Connector
if (!running)
return;
if (logger.isLoggable(Level.FINEST))
{
if (logger.isLoggable(Level.FINEST)){
logger.finest("received datagram packet - addr: "
+ packet.getAddress() + " port: " + packet.getPort());
}
@ -232,7 +230,7 @@ class Connector
listenAddress.getTransport()),
listenAddress);
messageConsumer.accept(rawMessage);
messageQueue.add(rawMessage);
}
catch (SocketException ex)
{
@ -326,16 +324,8 @@ class Connector
DatagramPacket datagramPacket
= new DatagramPacket(message, 0, message.length, address);
IceSocketWrapper sock = this.sock;
if (sock != null)
{
sock.send(datagramPacket);
}
else
{
logger.warning("Can not send message, Connector stopped.");
}
}
/**
* Returns a String representation of the object.

View File

@ -1,216 +0,0 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.stack;
import java.util.concurrent.atomic.*;
import java.util.function.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.message.*;
/**
* The class is used to parse and dispatch incoming messages by being
* executed by concurrent {@link java.util.concurrent.ExecutorService}.
* To reduce memory allocation this class is designed to be suitable for
* usage with pooling, the instance of this type is mutable such that
* <tt>RawMessage</tt> can be updated and instance can be reused and
* scheduled with new <tt>RawMessage</tt>
*
* @author Emil Ivov
* @author Yura Yaroshevich
*/
class MessageProcessingTask
implements Runnable
{
/**
* Our class logger.
*/
private static final Logger logger
= Logger.getLogger(MessageProcessingTask.class.getName());
/**
* Indicates that <tt>MessageProcessingTask</tt> is cancelled and should not
* process <tt>RawMessage</tt> anymore.
*/
private final AtomicBoolean cancelled = new AtomicBoolean(false);
/**
* The <tt>NetAccessManager</tt> which has created this instance and which
* is its owner.
*/
private final NetAccessManager netAccessManager;
/**
* The listener that will be collecting error notifications.
*/
private final ErrorHandler errorHandler;
/**
* The listener that will be retrieving <tt>MessageEvent</tt>s
*/
private final MessageEventHandler messageEventHandler;
/**
* Raw message which is being processed
*/
private RawMessage rawMessage;
/**
* Callback which is invoked when this <tt>MessageProcessingTask</tt>
* processed it's {@link #rawMessage}
*/
private Consumer<MessageProcessingTask> rawMessageProcessedHandler;
/**
* Creates a Message processor.
*
* @param netAccessManager the <tt>NetAccessManager</tt> which is creating
* the new instance, is going to be its owner, specifies the
* <tt>MessageEventHandler</tt> and represents the <tt>ErrorHandler</tt> to
* handle exceptions in the new instance
* @throws IllegalArgumentException if any of the mentioned properties of
* <tt>netAccessManager</tt> are <tt>null</tt>
*/
MessageProcessingTask(NetAccessManager netAccessManager)
throws IllegalArgumentException
{
if (netAccessManager == null)
{
throw new NullPointerException("netAccessManager");
}
MessageEventHandler messageEventHandler
= netAccessManager.getMessageEventHandler();
if (messageEventHandler == null)
{
throw new IllegalArgumentException(
"The message event handler may not be null");
}
this.netAccessManager = netAccessManager;
this.messageEventHandler = messageEventHandler;
this.errorHandler = netAccessManager;
}
/**
* Assigns the <tt>RawMessage</tt> that will be processed
* by this <tt>MessageProcessingTask</tt> on executor's thread.
* @param message RawMessage to be processed
* @param onProcessed callback which will be invoked when processing
* of {@link #rawMessage} is completed
*/
void setMessage(
RawMessage message,
Consumer<MessageProcessingTask> onProcessed)
{
if (message == null)
{
throw new IllegalArgumentException("The message may not be null");
}
rawMessage = message;
rawMessageProcessedHandler = onProcessed;
}
/**
* Performs proper reset of internal state of pooled instance.
*/
void resetState()
{
cancelled.set(false);
rawMessage = null;
rawMessageProcessedHandler = null;
}
/**
* Attempts to cancel processing of {@link #rawMessage}
*/
public void cancel()
{
cancelled.set(true);
}
/**
* Does the message parsing.
*/
@Override
public void run()
{
final Consumer<MessageProcessingTask> onProcessed
= rawMessageProcessedHandler;
final RawMessage message = rawMessage;
//add an extra try/catch block that handles uncatched errors
try
{
if (message == null)
{
return;
}
rawMessage = null;
rawMessageProcessedHandler = null;
if (cancelled.get())
{
return;
}
StunStack stunStack = netAccessManager.getStunStack();
Message stunMessage;
try
{
stunMessage
= Message.decode(message.getBytes(),
0,
message.getMessageLength());
}
catch (StunException ex)
{
errorHandler.handleError(
"Failed to decode a stun message!",
ex);
return;
}
logger.finest("Dispatching a StunMessageEvent.");
StunMessageEvent stunMessageEvent
= new StunMessageEvent(stunStack, message, stunMessage);
messageEventHandler.handleMessageEvent(stunMessageEvent);
}
catch (Throwable err)
{
errorHandler.handleFatalError(
Thread.currentThread(),
"Unexpected Error!", err);
}
finally
{
// On processed callback must be invoked in all cases, even when
// cancellation or early exist happen, otherwise
// NetAccessManager internal tracking of pooled and active
// message processors will misbehave.
if (onProcessed != null)
{
onProcessed.accept(this);
}
}
}
}

View File

@ -0,0 +1,212 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.stack;
import java.util.concurrent.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.message.*;
/**
* The class is used to parse and dispatch incoming messages in a multi-thread
* manner.
*
* @author Emil Ivov
*/
class MessageProcessor
implements Runnable
{
/**
* Our class logger.
*/
private static final Logger logger
= Logger.getLogger(MessageProcessor.class.getName());
/**
* The listener that will be collecting error notifications.
*/
private final ErrorHandler errorHandler;
/**
* The queue where we store incoming messages until they are collected.
*/
private final BlockingQueue<RawMessage> messageQueue;
/**
* The listener that will be retrieving <tt>MessageEvent</tt>s
*/
private final MessageEventHandler messageEventHandler;
/**
* The <tt>NetAccessManager</tt> which has created this instance and which
* is its owner.
*/
private final NetAccessManager netAccessManager;
/**
* The flag that indicates whether we are still running.
*/
private boolean running = false;
/**
* A reference to the thread that we use to execute ourselves.
*/
private Thread runningThread = null;
/**
* Creates a Message processor.
*
* @param netAccessManager the <tt>NetAccessManager</tt> which is creating
* the new instance, is going to be its owner, specifies the
* <tt>BlockingQueue</tt> which is to store incoming messages, specifies the
* <tt>MessageEventHandler</tt> and represents the <tt>ErrorHandler</tt> to
* handle exceptions in the new instance
* @throws IllegalArgumentException if any of the mentioned properties of
* <tt>netAccessManager</tt> are <tt>null</tt>
*/
MessageProcessor(NetAccessManager netAccessManager)
throws IllegalArgumentException
{
if (netAccessManager == null)
throw new NullPointerException("netAccessManager");
BlockingQueue<RawMessage> messageQueue = netAccessManager.getMessageQueue();
if (messageQueue == null)
{
throw new IllegalArgumentException(
"The message queue may not be null");
}
MessageEventHandler messageEventHandler
= netAccessManager.getMessageEventHandler();
if(messageEventHandler == null)
{
throw new IllegalArgumentException(
"The message event handler may not be null");
}
this.netAccessManager = netAccessManager;
this.messageQueue = messageQueue;
this.messageEventHandler = messageEventHandler;
this.errorHandler = netAccessManager;
}
/**
* Does the message parsing.
*/
public void run()
{
//add an extra try/catch block that handles uncatched errors and helps
//avoid having dead threads in our pools.
try
{
StunStack stunStack = netAccessManager.getStunStack();
while (running)
{
RawMessage rawMessage;
try
{
rawMessage = messageQueue.take();
}
catch (InterruptedException ex)
{
if(isRunning())
logger.log(Level.WARNING,
"A net access point has gone useless: ", ex);
//nothing to do here since we test whether we are running
//just beneath ...
rawMessage = null;
}
// were we asked to stop?
if (!isRunning())
return;
//anything to parse?
if (rawMessage == null)
continue;
Message stunMessage = null;
try
{
stunMessage
= Message.decode(rawMessage.getBytes(),
(char) 0,
(char) rawMessage.getMessageLength());
}
catch (StunException ex)
{
errorHandler.handleError(
"Failed to decode a stun message!",
ex);
continue; //let this one go and for better luck next time.
}
logger.finest("Dispatching a StunMessageEvent.");
StunMessageEvent stunMessageEvent
= new StunMessageEvent(stunStack, rawMessage,
stunMessage);
messageEventHandler.handleMessageEvent(stunMessageEvent);
}
}
catch(Throwable err)
{
//notify and bail
errorHandler.handleFatalError(this, "Unexpected Error!", err);
}
}
/**
* Start the message processing thread.
*/
void start()
{
this.running = true;
runningThread = new Thread(this, "Stun4J Message Processor");
runningThread.setDaemon(true);
runningThread.start();
}
/**
* Shut down the message processor.
*/
void stop()
{
this.running = false;
runningThread.interrupt();
}
/**
* Determines whether the processor is still running;
*
* @return true if the processor is still authorized to run, and false
* otherwise.
*/
boolean isRunning()
{
return running;
}
}

View File

@ -17,32 +17,28 @@
*/
package org.ice4j.stack;
import org.ice4j.*;
import org.ice4j.message.*;
import org.ice4j.socket.*;
import org.jitsi.utils.concurrent.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.concurrent.atomic.*;
import java.util.function.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.message.*;
import org.ice4j.socket.*;
/**
* Manages <tt>Connector</tt>s and <tt>MessageProcessingTask</tt> execution and
* pooling. This class serves as a layer that masks network primitives and
* provides equivalent STUN abstractions. Instances that operate with
* the NetAccessManager are only supposed to understand STUN talk and
* shouldn't be aware of datagrams sockets, and etc.
* Manages <tt>Connector</tt>s and <tt>MessageProcessor</tt> pooling. This class
* serves as a layer that masks network primitives and provides equivalent STUN
* abstractions. Instances that operate with the NetAccessManager are only
* supposed to understand STUN talk and shouldn't be aware of datagrams sockets,
* and etc.
*
* @author Emil Ivov
* @author Aakash Garg
* @author Boris Grozev
* @author Yura Yaroshevich
*/
public class NetAccessManager
class NetAccessManager
implements ErrorHandler
{
/**
@ -51,35 +47,6 @@ public class NetAccessManager
private static final Logger logger
= Logger.getLogger(NetAccessManager.class.getName());
/**
* Thread pool to execute {@link MessageProcessingTask}s across all
* {@link NetAccessManager}s.
*/
private static ExecutorService messageProcessingExecutor
= ExecutorFactory.createCachedThreadPool("ice4j.NetAccessManager-");
/**
* Maximum number of {@link MessageProcessingTask} to keep in object pool.
* Each {@link NetAccessManager} has it's own pool, small pool size is
* enough to save allocations.
*/
private static final int TASK_POOL_SIZE = 8;
/**
* Pool of <tt>MessageProcessingTask</tt> objects to avoid extra-allocations
* of processor object per <tt>RawMessage</tt> needed to process.
*/
private final ArrayBlockingQueue<MessageProcessingTask> taskPool
= new ArrayBlockingQueue<>(TASK_POOL_SIZE);
/**
* The set of {@link MessageProcessingTask}'s which are not yet finished
* it's, processing, tracking of active tasks is necessary to properly
* cancel pending tasks in case {@link #stop()} is called.
*/
private final ConcurrentHashMap.KeySetView<MessageProcessingTask, Boolean>
activeTasks = ConcurrentHashMap.newKeySet();
/**
* All <tt>Connectors</tt> currently in use with UDP. The table maps a local
* <tt>TransportAddress</tt> and and a remote <tt>TransportAddress</tt> to
@ -110,6 +77,16 @@ public class NetAccessManager
tcpConnectors
= new HashMap<>();
/**
* A synchronized FIFO where incoming messages are stocked for processing.
*/
private final BlockingQueue<RawMessage> messageQueue = new LinkedBlockingQueue<>();
/**
* A thread pool of message processors.
*/
private final Vector<MessageProcessor> messageProcessors = new Vector<>();
/**
* The instance that should be notified when an incoming message has been
* processed and ready for delivery
@ -128,34 +105,17 @@ public class NetAccessManager
*/
private final ChannelDataEventHandler channelDataEventHandler;
/**
* The size of the thread pool to start with.
*/
private int initialThreadPoolSize = StunStack.DEFAULT_THREAD_POOL_SIZE;
/**
* The <tt>StunStack</tt> which has created this instance, is its owner and
* is the handler that incoming message requests should be passed to.
*/
private final StunStack stunStack;
/**
* Indicates if this <tt>NetAccessManager</tt> is stopped
*/
private final AtomicBoolean isStopped = new AtomicBoolean(false);
/**
* Callback to be called when scheduled <tt>MessageProcessingTask</tt>
* completes processing it's <tt>RawMessage</tt>.
*/
private final Consumer<MessageProcessingTask> onRawMessageProcessed
= messageProcessingTask -> {
activeTasks.remove(messageProcessingTask);
final boolean isAdded = taskPool.offer(messageProcessingTask);
if (!isAdded && logger.isLoggable(Level.FINEST))
{
logger.finest("Dropping MessageProcessingTask for "
+ this + " because pool is full, max pool size is " + TASK_POOL_SIZE);
}
};
/**
* Constructs a NetAccessManager.
*
@ -190,6 +150,7 @@ public class NetAccessManager
this.messageEventHandler = stunStack;
this.peerUdpMessageEventHandler = peerUdpMessageEventHandler;
this.channelDataEventHandler = channelDataEventHandler;
initThreadPool();
}
/**
@ -235,6 +196,17 @@ public class NetAccessManager
return channelDataEventHandler;
}
/**
* Gets the <tt>BlockingQueue</tt> of this <tt>NetAccessManager</tt> in which
* incoming messages are stocked for processing.
*
* @return the <tt>BlockingQueue</tt> of this <tt>NetAccessManager</tt> in
* which incoming messages are stocked for processing
*/
BlockingQueue<RawMessage> getMessageQueue()
{
return messageQueue;
}
/**
* Gets the <tt>StunStack</tt> which has created this instance and is its
@ -256,12 +228,6 @@ public class NetAccessManager
@Override
public void handleError(String message, Throwable error)
{
if (isStopped.get())
{
logger.log(Level.WARNING,
"Got error when stopped, ignoring: " + message, error);
return;
}
/**
* apart from logging, i am not sure what else we could do here.
*/
@ -283,13 +249,6 @@ public class NetAccessManager
String message,
Throwable error)
{
if (isStopped.get())
{
logger.log(Level.WARNING,
"Got fatal error when stopped, ignoring: " + message, error);
return;
}
if (callingThread instanceof Connector)
{
Connector connector = (Connector)callingThread;
@ -301,15 +260,25 @@ public class NetAccessManager
{
logger.log(Level.WARNING, "Removing connector:" + connector,
error);
}
else if (logger.isLoggable(Level.FINE))
} else if (logger.isLoggable(Level.FINE))
{
logger.fine("Removing connector " + connector);
}
}
else
else if( callingThread instanceof MessageProcessor )
{
logger.log(Level.SEVERE, message, error);
MessageProcessor mp = (MessageProcessor)callingThread;
logger.log( Level.WARNING, "A message processor has unexpectedly "
+ "stopped. AP:" + mp, error);
//make sure the guy's dead.
mp.stop();
messageProcessors.remove(mp);
mp = new MessageProcessor(this);
mp.start();
logger.fine("A message processor has been relaunched because "
+ "of an error.");
}
}
@ -380,11 +349,7 @@ public class NetAccessManager
if (!connectorsForLocalAddress.containsKey(remoteAddress))
{
Connector connector
= new Connector(
socket,
remoteAddress,
this::onIncomingRawMessage,
this);
= new Connector(socket, remoteAddress, messageQueue, this);
connectorsForLocalAddress.put(remoteAddress, connector);
connector.start();
@ -440,24 +405,15 @@ public class NetAccessManager
}
/**
* Stops <tt>NetAccessManager</tt> and all of its active
* <tt>MessageProcessingTask</tt>.
* Stops <tt>NetAccessManager</tt> and all of its <tt>MessageProcessor</tt>.
*/
@SuppressWarnings("unchecked")
public void stop()
{
// Mark NetAccessManager as stopped, it will immediately result in
// ignoring of all concurrent requests to handle messages
isStopped.set(true);
// no item can be added to {@link #activeTasks} when
// NetAccessManager is stopped, so it is safe to iterate without
// removing item in-place.
for (MessageProcessingTask messageProcessingTask : activeTasks)
for(MessageProcessor mp : messageProcessors)
{
messageProcessingTask.cancel();
mp.stop();
}
activeTasks.clear();
for (Object o : new Object[]{udpConnectors, tcpConnectors})
{
@ -519,43 +475,81 @@ public class NetAccessManager
return connector;
}
//---------------thread pool implementation --------------------------------
/**
* Enqueues incoming {@link RawMessage} for asynchronous
* processing by {@link #messageProcessingExecutor}
* @param message <tt>RawMessage</tt> to process
* Adjusts the number of concurrently running MessageProcessors.
* If the number is smaller or bigger than the number of threads
* currently running, then message processors are created/deleted so that
* their count matches the new value.
*
* @param threadPoolSize the number of MessageProcessors that should be
* running concurrently
* @throws IllegalArgumentException if threadPoolSize is not a valid size.
*/
private void onIncomingRawMessage(final RawMessage message)
void setThreadPoolSize(int threadPoolSize)
throws IllegalArgumentException
{
if (isStopped.get())
if(threadPoolSize < 1)
{
logger.fine("Got RawMessage when stopped, ignore it.");
return;
throw new IllegalArgumentException(
threadPoolSize + " is not a legal thread pool size value.");
}
MessageProcessingTask messageProcessingTask
= taskPool.poll();
if (messageProcessingTask == null)
//if we are not running just record the size
//so that we could init later.
if(messageProcessors.size() < threadPoolSize)
{
messageProcessingTask
= new MessageProcessingTask(this);
if (logger.isLoggable(Level.FINEST))
{
logger.finest("Allocated new MessageProcessingTask for "
+ this + " due to absence of available pooled instances");
}
//create additional processors
fillUpThreadPool(threadPoolSize);
}
else
{
messageProcessingTask.resetState();
//delete extra processors
shrinkThreadPool(threadPoolSize);
}
}
messageProcessingTask.setMessage(message, onRawMessageProcessed);
/**
* Fills the thread pool with the initially specified number of message
* processors.
*/
private void initThreadPool()
{
//create additional processors
fillUpThreadPool(initialThreadPoolSize);
}
activeTasks.add(messageProcessingTask);
/**
* Starts all message processors
*
* @param newSize the new thread pool size
*/
private void fillUpThreadPool(int newSize)
{
//make sure we don't resize more than once
messageProcessors.ensureCapacity(newSize);
// Use overload which does not return Future object to avoid
// unnecessary allocation
messageProcessingExecutor.execute(messageProcessingTask);
for (int i = messageProcessors.size(); i < newSize; i++)
{
MessageProcessor mp = new MessageProcessor(this);
messageProcessors.add(mp);
mp.start();
}
}
/**
* Stops message processors until processors count equals newSize.
*
* @param newSize the new thread pool size
*/
private void shrinkThreadPool(int newSize)
{
while(messageProcessors.size() > newSize)
{
MessageProcessor mp = messageProcessors.remove(0);
mp.stop();
}
}
//--------------- SENDING MESSAGES -----------------------------------------
@ -628,17 +622,10 @@ public class NetAccessManager
Connector ap = getConnector(srcAddr, remoteAddr);
if (ap == null)
{
throw new SocketNotFoundException("No socket found for " + srcAddr + "->" + remoteAddr);
throw new IllegalArgumentException(
"No socket found for " + srcAddr + "->" + remoteAddr);
}
ap.sendMessage(bytes, remoteAddr);
}
public class SocketNotFoundException extends IllegalArgumentException
{
private SocketNotFoundException(String message)
{
super(message);
}
}
}

View File

@ -17,16 +17,13 @@
*/
package org.ice4j.stack;
import java.io.*;
import java.util.concurrent.*;
import java.util.concurrent.locks.*;
import java.util.logging.*;
import org.ice4j.*;
import org.ice4j.message.*;
import org.ice4j.util.PeriodicRunnable;
import org.jitsi.utils.concurrent.*;
import java.io.*;
import java.time.*;
import java.util.concurrent.*;
import java.util.concurrent.atomic.*;
import java.util.logging.*;
/**
* The {@code StunClientTransaction} class retransmits requests as specified by
@ -49,12 +46,13 @@ import java.util.logging.*;
* @author Lyubomir Marinov
*/
public class StunClientTransaction
implements Runnable
{
/**
* Our class logger.
*/
private static final java.util.logging.Logger logger
= java.util.logging.Logger.getLogger(StunClientTransaction.class.getName());
private static final Logger logger
= Logger.getLogger(StunClientTransaction.class.getName());
/**
* The number of times to retransmit a request if no explicit value has been
@ -76,21 +74,43 @@ public class StunClientTransaction
public static final int DEFAULT_ORIGINAL_WAIT_INTERVAL = 100;
/**
* The pool of <tt>Thread</tt>s which schedules retransmission of
* The pool of <tt>Thread</tt>s which retransmit
* <tt>StunClientTransaction</tt>s.
*/
private static final ScheduledExecutorService retransmissionTimer
= ExecutorFactory.createSingleThreadScheduledExecutor(
"ice4j.StunClientTransaction-timer-", 60, TimeUnit.SECONDS);
private static final ExecutorService retransmissionThreadPool
= Executors.newCachedThreadPool(
new ThreadFactory()
{
/**
* The pool of <tt>Thread</tt>s which retransmits
* <tt>StunClientTransaction</tt>s.
* The default {@code ThreadFactory} implementation which is
* augmented by this instance to create daemon
* {@code Thread}s.
*/
private static final ExecutorService retransmissionExecutor
= ExecutorFactory.createCachedThreadPool(
"ice4j.StunClientTransaction-executor-");
private final ThreadFactory defaultThreadFactory
= Executors.defaultThreadFactory();
@Override
public Thread newThread(Runnable r)
{
Thread t = defaultThreadFactory.newThread(r);
if (t != null)
{
t.setDaemon(true);
// Additionally, make it known through the name of
// the Thread that it is associated with the
// StunClientTransaction class for
// debugging/informational purposes.
String name = t.getName();
if (name == null)
name = "";
t.setName("StunClientTransaction-" + name);
}
return t;
}
});
/**
* Maximum number of retransmissions. Once this number is reached and if no
@ -146,12 +166,25 @@ public class StunClientTransaction
/**
* Determines whether the transaction is active or not.
*/
private final AtomicBoolean cancelled = new AtomicBoolean(false);
private boolean cancelled = false;
/**
* A transaction request retransmitter
* The <tt>Lock</tt> which synchronizes the access to the state of this
* instance. Introduced along with {@link #lockCondition} in order to allow
* the invocation of {@link #cancel(boolean)} without a requirement to
* acquire the synchronization root. Otherwise, callers of
* <tt>cancel(boolean)</tt> may (and have be reported multiple times to)
* fall into a deadlock merely because they want to cancel this
* <tt>StunClientTransaction</tt>.
*/
private final Retransmitter retransmitter;
private final Lock lock = new ReentrantLock();
/**
* The <tt>Condition</tt> of {@link #lock} which this instance uses to wait
* for either the next retransmission interval or the cancellation of this
* <tt>StunClientTransaction</tt>.
*/
private final Condition lockCondition = lock.newCondition();
/**
* Creates a client transaction.
@ -207,8 +240,6 @@ public class StunClientTransaction
initTransactionConfiguration();
retransmitter = new Retransmitter(); // create it here to support 'originalWaitInterval' configuration
this.transactionID = transactionID;
try
@ -225,6 +256,102 @@ public class StunClientTransaction
}
}
/**
* Implements the retransmissions algorithm. Retransmits the request
* starting with an interval of 100ms, doubling every retransmit until the
* interval reaches 1.6s. Retransmissions continue with intervals of 1.6s
* until a response is received, or a total of 7 requests have been sent.
* If no response is received by 1.6 seconds after the last request has been
* sent, we consider the transaction to have failed.
* <p>
* The method acquires {@link #lock} and invokes {@link #runLocked()}.
* </p>
*/
@Override
public void run()
{
lock.lock();
try
{
runLocked();
}
finally
{
lock.unlock();
}
}
/**
* Implements the retransmissions algorithm. Retransmits the request
* starting with an interval of 100ms, doubling every retransmit until the
* interval reaches 1.6s. Retransmissions continue with intervals of 1.6s
* until a response is received, or a total of 7 requests have been sent.
* If no response is received by 1.6 seconds after the last request has been
* sent, we consider the transaction to have failed.
* <p>
* The method assumes that the current thread has already acquired
* {@link #lock}.
* </p>
*/
private void runLocked()
{
// Indicates how many times we have retransmitted so far.
int retransmissionCounter = 0;
// How much did we wait after our last retransmission?
int nextWaitInterval = originalWaitInterval;
for (retransmissionCounter = 0;
retransmissionCounter < maxRetransmissions;
retransmissionCounter ++)
{
waitFor(nextWaitInterval);
//did someone tell us to get lost?
if(cancelled)
return;
int curWaitInterval = nextWaitInterval;
if(nextWaitInterval < maxWaitInterval)
nextWaitInterval *= 2;
try
{
logger.fine(
"retrying STUN tid " + transactionID + " from "
+ localAddress + " to " + requestDestination
+ " waited " + curWaitInterval + " ms retrans "
+ (retransmissionCounter + 1) + " of "
+ maxRetransmissions);
sendRequest0();
}
catch (Exception ex)
{
//I wonder whether we should notify anyone that a retransmission
// has failed
logger.log(
Level.INFO,
"A client tran retransmission failed",
ex);
}
}
//before stating that a transaction has timeout-ed we should first wait
//for a reception of the response
if(nextWaitInterval < maxWaitInterval)
nextWaitInterval *= 2;
waitFor(nextWaitInterval);
if(cancelled)
return;
stackCallback.removeClientTransaction(this);
responseCollector.processTimeout(
new StunTimeoutEvent(
stackCallback,
this.request, getLocalAddress(), transactionID));
}
/**
* Sends the request and schedules the first retransmission for after
* {@link #originalWaitInterval} and thus starts the retransmission
@ -244,7 +371,7 @@ public class StunClientTransaction
+ localAddress + " to " + requestDestination);
sendRequest0();
this.retransmitter.schedule();
retransmissionThreadPool.execute(this);
}
/**
@ -258,7 +385,7 @@ public class StunClientTransaction
private void sendRequest0()
throws IllegalArgumentException, IOException
{
if (cancelled.get())
if(cancelled)
{
logger.finer("Trying to resend a cancelled transaction.");
}
@ -281,18 +408,74 @@ public class StunClientTransaction
return this.request;
}
/**
* Waits until next retransmission is due or until the transaction is
* cancelled (whichever comes first).
*
* @param millis the number of milliseconds to wait for.
*/
void waitFor(long millis)
{
lock.lock();
try
{
lockCondition.await(millis, TimeUnit.MILLISECONDS);
}
catch (InterruptedException ex)
{
throw new RuntimeException(ex);
}
finally
{
lock.unlock();
}
}
/**
* Cancels the transaction. Once this method is called the transaction is
* considered terminated and will stop retransmissions.
*
* @param waitForResponse indicates whether we should wait for the current
* RTO to expire before ending the transaction or immediately terminate.
*/
void cancel(boolean waitForResponse)
{
// XXX The cancelled field is initialized to false and then the one and
// only write access to it is here to set it to true. The rest of the
// code just checks whether it has become true. Consequently, there
// shouldn't be a problem if the set is outside a synchronized block.
// However, it being outside a synchronized block will decrease the risk
// of deadlocks.
cancelled = true;
if(!waitForResponse)
{
// Try to interrupt #waitFor(long) if possible. But don't risk a
// deadlock. It is not a problem if it is not possible to interrupt
// #waitFor(long) here because it will complete in finite time and
// this StunClientTransaction will eventually notice that it has
// been cancelled.
if (lock.tryLock())
{
try
{
lockCondition.signal();
}
finally
{
lock.unlock();
}
}
}
}
/**
* Cancels the transaction. Once this method is called the transaction is
* considered terminated and will stop retransmissions.
*/
void cancel()
{
// The cancelled field is initialized to false and then the one and
// only write access to it is here to set it to true. The rest of the
// code just checks whether it has become true.
cancelled.set(true);
this.retransmitter.cancel();
cancel(false);
}
/**
@ -302,14 +485,15 @@ public class StunClientTransaction
* @param evt the event that contains the newly received message
*/
public void handleResponse(StunMessageEvent evt)
{
lock.lock();
try
{
TransactionID transactionID = getTransactionID();
logger.fine("handleResponse tid " + transactionID);
logger.log(Level.FINE, "handleResponse tid " + transactionID);
if(!Boolean.getBoolean(StackProperties.KEEP_CRANS_AFTER_A_RESPONSE))
{
cancel();
}
responseCollector.processResponse(
new StunResponseEvent(
@ -319,6 +503,11 @@ public class StunClientTransaction
request,
transactionID));
}
finally
{
lock.unlock();
}
}
/**
* Returns the ID of the current transaction.
@ -419,81 +608,4 @@ public class StunClientTransaction
{
return requestDestination;
}
/**
* Implements the retransmissions algorithm. Retransmits the request
* starting with an interval of 100ms, doubling every retransmit until the
* interval reaches 1.6s. Retransmissions continue with intervals of 1.6s
* until a response is received, or a total of 7 requests have been sent.
* If no response is received by 1.6 seconds after the last request has been
* sent, we consider the transaction to have failed.
*/
private final class Retransmitter extends PeriodicRunnable
{
/**
* Current number of retransmission attempts
*/
private int retransmissionCounter = 0;
/**
* Delay before attempting next retransmission
*/
private int nextRetransmissionDelay = originalWaitInterval;
protected Retransmitter()
{
super(retransmissionTimer, retransmissionExecutor);
}
@Override
protected Duration getDelayUntilNextRun()
{
return Duration.ofMillis(nextRetransmissionDelay);
}
@Override
protected void run()
{
retransmissionCounter++;
int curWaitInterval = nextRetransmissionDelay;
nextRetransmissionDelay
= Math.min(maxWaitInterval, 2 * nextRetransmissionDelay);
if (retransmissionCounter <= maxRetransmissions)
{
try
{
logger.fine(
"retrying STUN tid " + transactionID + " from "
+ localAddress + " to " + requestDestination
+ " waited " + curWaitInterval + " ms retrans "
+ retransmissionCounter + " of "
+ maxRetransmissions);
sendRequest0();
}
catch (Exception ex)
{
//I wonder whether we should notify anyone that a retransmission
// has failed
logger.log(
Level.INFO,
"A client tran retransmission failed",
ex);
}
}
else
{
stackCallback.removeClientTransaction(
StunClientTransaction.this);
responseCollector.processTimeout(
new StunTimeoutEvent(
stackCallback,
getRequest(), getLocalAddress(), getTransactionID()));
nextRetransmissionDelay = -1;
}
}
}
}

View File

@ -165,8 +165,7 @@ public class StunServerTransaction
IOException,
IllegalArgumentException
{
if (!isRetransmitting)
{
if(!isRetransmitting){
this.response = response;
//the transaction id might already have been set, but its our job
//to make sure of that

View File

@ -17,20 +17,19 @@
*/
package org.ice4j.stack;
import java.io.*;
import java.net.*;
import java.security.*;
import java.util.*;
import java.util.logging.*;
import javax.crypto.*;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.ice4j.message.*;
import org.ice4j.security.*;
import org.ice4j.socket.*;
import org.jitsi.utils.concurrent.*;
import javax.crypto.*;
import java.io.*;
import java.net.*;
import java.security.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
/**
* The entry point to the Stun4J stack. The class is used to start, stop and
@ -43,12 +42,18 @@ import java.util.logging.*;
public class StunStack
implements MessageEventHandler
{
/**
* The number of threads to split our flow in.
*/
public static final int DEFAULT_THREAD_POOL_SIZE = 3;
/**
* The <tt>Logger</tt> used by the <tt>StunStack</tt> class and its
* instances for logging output.
*/
private static final java.util.logging.Logger logger
= java.util.logging.Logger.getLogger(StunStack.class.getName());
private static final Logger logger
= Logger.getLogger(StunStack.class.getName());
/**
* The indicator which determines whether
@ -59,14 +64,6 @@ public class StunStack
*/
private static Mac mac;
/**
* The ScheduledExecutorService to execute StunStack scheduled tasks,
* in particular - expired server transactions collector.
*/
private static final ScheduledExecutorService tasksScheduler
= ExecutorFactory.createSingleThreadScheduledExecutor(
"ice4j.StunStack-", 60, TimeUnit.SECONDS);
/**
* Our network gateway.
*/
@ -87,12 +84,11 @@ public class StunStack
= new Hashtable<>();
/**
* The <tt>ExpiredServerTransactionsCollector</tt> which expires
* the <tt>StunServerTransaction</tt>s of this <tt>StunStack</tt> and
* removes them from {@link #serverTransactions}.
* The <tt>Thread</tt> which expires the <tt>StunServerTransaction</tt>s of
* this <tt>StunStack</tt> and removes them from
* {@link #serverTransactions}.
*/
private ExpiredServerTransactionsCollector expiredTransactionsCollector
= new ExpiredServerTransactionsCollector();
private Thread serverTransactionExpireThread;
/**
* Currently open server transactions. The vector contains transaction ids
@ -112,6 +108,18 @@ public class StunStack
*/
private static PacketLogger packetLogger;
/**
* Sets the number of Message processors running in the same time.
*
* @param threadPoolSize the number of message process threads to run.
* @throws IllegalArgumentException if threadPoolSize is not a valid size.
*/
public void setThreadPoolSize(int threadPoolSize)
throws IllegalArgumentException
{
netAccessManager.setThreadPoolSize(threadPoolSize);
}
/**
* Creates and starts a Network Access Point (Connector) based on the
* specified socket.
@ -400,6 +408,7 @@ public class StunStack
new NetAccessManager(this, peerUdpMessageEventHandler,
channelDataEventHandler);
}
/**
* Initializes a new <tt>StunStack</tt> instance.
*/
@ -941,7 +950,10 @@ public class StunStack
ev.getLocalAddress(),
ev.getRemoteAddress());
// if there is an OOM error here, stop here right now
// if there is an OOM error here, it will lead to
// NetAccessManager.handleFatalError that will stop the
// MessageProcessor thread and restart it that will lead again
// to an OOM error and so on... So stop here right now
try
{
sTran.start();
@ -954,7 +966,7 @@ public class StunStack
synchronized (serverTransactions)
{
serverTransactions.put(serverTid, sTran);
expiredTransactionsCollector.schedule();
maybeStartServerTransactionExpireThread();
}
}
@ -1094,8 +1106,6 @@ public class StunStack
// serverTransactions
Collection<StunServerTransaction> serverTransactionsToExpire;
expiredTransactionsCollector.cancel();
synchronized (serverTransactions)
{
serverTransactionsToExpire
@ -1432,6 +1442,135 @@ public class StunStack
return packetLogger != null && packetLogger.isEnabled();
}
/**
* Initializes and starts {@link #serverTransactionExpireThread} if
* necessary.
*/
private void maybeStartServerTransactionExpireThread()
{
synchronized (serverTransactions)
{
if (!serverTransactions.isEmpty()
&& (serverTransactionExpireThread == null))
{
Thread t
= new Thread()
{
@Override
public void run()
{
runInServerTransactionExpireThread();
}
};
t.setDaemon(true);
t.setName(
getClass().getName()
+ ".serverTransactionExpireThread");
boolean started = false;
serverTransactionExpireThread = t;
try
{
t.start();
started = true;
}
finally
{
if (!started && (serverTransactionExpireThread == t))
serverTransactionExpireThread = null;
}
}
}
}
/**
* Runs in {@link #serverTransactionExpireThread} and expires the
* <tt>StunServerTransaction</tt>s of this <tt>StunStack</tt> and removes
* them from {@link #serverTransactions}.
*/
private void runInServerTransactionExpireThread()
{
try
{
long idleStartTime = -1;
do
{
synchronized (serverTransactions)
{
try
{
serverTransactions.wait(StunServerTransaction.LIFETIME);
}
catch (InterruptedException ie)
{
}
/*
* Is the current Thread still designated to expire the
* StunServerTransactions of this StunStack?
*/
if (Thread.currentThread() != serverTransactionExpireThread)
break;
long now = System.currentTimeMillis();
/*
* Has the current Thread been idle long enough to merit
* disposing of it?
*/
if (serverTransactions.isEmpty())
{
if (idleStartTime == -1)
idleStartTime = now;
else if (now - idleStartTime > 60 * 1000)
break;
}
else
{
// Expire the StunServerTransactions of this StunStack.
idleStartTime = -1;
for (Iterator<StunServerTransaction> i
= serverTransactions.values().iterator();
i.hasNext();)
{
StunServerTransaction serverTransaction = i.next();
if (serverTransaction == null)
{
i.remove();
}
else if (serverTransaction.isExpired(now))
{
i.remove();
serverTransaction.expire();
}
}
}
}
}
while (true);
}
finally
{
synchronized (serverTransactions)
{
if (serverTransactionExpireThread == Thread.currentThread())
serverTransactionExpireThread = null;
/*
* If serverTransactionExpireThread dies unexpectedly and yet it
* is still necessary, resurrect it.
*/
if (serverTransactionExpireThread == null)
maybeStartServerTransactionExpireThread();
}
}
}
/**
* Returns the Error Response object with specified errorCode and
* reasonPhrase corresponding to input type.
@ -1500,117 +1639,4 @@ public class StunStack
}
}
/**
* Class which performs periodic collection of expired transactions.
* It's execution is controlled outside by {@link #schedule()}
* and {@link #cancel()} methods. Whenever expired transactions collector
* is scheduled it does self reschedule with fixed delay
* of StunServerTransaction.LIFETIME_MILLIS,
* until {@link #serverTransactions} is empty, in that case it self-cancel
* further execution and need to be scheduled again when new item added
* to {@link #serverTransactions} container.
*/
private final class ExpiredServerTransactionsCollector
{
/**
* Runnable which walks {@link #serverTransactions}, check if
* transaction is expired and if so - remove it
* from {@link #serverTransactions}.
* Self-cancels when {@link #serverTransactions} is empty
*/
private final Runnable collector = new Runnable()
{
@Override
public void run()
{
try
{
synchronized (serverTransactions)
{
final int transactionsBeforeCollection
= serverTransactions.size();
long now = System.currentTimeMillis();
for (Iterator<StunServerTransaction> i
= serverTransactions.values().iterator();
i.hasNext();)
{
StunServerTransaction serverTransaction = i.next();
if (serverTransaction == null)
{
i.remove();
}
else if (serverTransaction.isExpired(now))
{
i.remove();
serverTransaction.expire();
}
}
logger.fine("Non-expired server transactions "
+ "count " + serverTransactions.size()
+ ", transactions before collection "
+ transactionsBeforeCollection);
if (serverTransactions.isEmpty())
{
cancel();
logger.finest("Cancel expired collector "
+ "due to no more server transactions");
}
}
}
catch (Throwable t)
{
logger.log(Level.FINE,
"Failed to expire server transactions", t);
}
}
};
/**
* Scheduled execution of {@link #collector} runnable.
* Access synchronized via {@link #serverTransactions}.
*/
private ScheduledFuture<?> scheduledCollectorFuture;
/**
* Schedules repeated collector execution in background
* task executor. If collector is already scheduled - do nothing
*/
void schedule()
{
synchronized (serverTransactions)
{
if (scheduledCollectorFuture == null ||
scheduledCollectorFuture.isDone())
{
scheduledCollectorFuture
= tasksScheduler.scheduleWithFixedDelay(
collector,
StunServerTransaction.LIFETIME,
StunServerTransaction.LIFETIME,
TimeUnit.MILLISECONDS);
}
}
}
/**
* Cancels execution of scheduled expired transactions collector if
* it is running
*/
void cancel()
{
synchronized (serverTransactions)
{
if (scheduledCollectorFuture != null)
{
scheduledCollectorFuture.cancel(false);
scheduledCollectorFuture = null;
}
}
}
}
}

View File

@ -409,8 +409,7 @@ public class NetworkConfigurationDiscoveryProcess
{
Request request = MessageFactory.createBindingRequest();
/* ChangeRequestAttribute changeRequest
= (ChangeRequestAttribute)request.getAttribute(Attribute.CHANGE_REQUEST); */
/* ChangeRequestAttribute changeRequest = (ChangeRequestAttribute)request.getAttribute(Attribute.CHANGE_REQUEST); */
/* add a change request attribute */
ChangeRequestAttribute changeRequest = AttributeFactory.createChangeRequestAttribute();
changeRequest.setChangeIpFlag(false);

View File

@ -0,0 +1,234 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.util;
import java.util.logging.*;
/**
* Implements a logger, which delegates to a {@link java.util.logging.Logger}
* instance, but maintains its own logging level.
*
* @author Boris Grozev
*/
public class Logger
{
/**
* The level of this logger.
*/
private Level level;
/**
* The underlying {@link java.util.logging.Logger} instance to which logging
* is delegated.
*/
private java.util.logging.Logger delegate;
/**
* The {@link Logger} instance (if any) which provides the log level of this
* instance.
*/
private Logger levelDelegate;
/**
* Initializes a new {@link Logger} instance with a given delegate and a
* given log level.
* @param delegate the delegate.
* @param level the log level.
*/
public Logger(java.util.logging.Logger delegate, Level level)
{
this.delegate = delegate;
this.level = level;
}
/**
* Initializes a new {@link Logger} instance with a given delegate and which
* uses the log level from another {@link Logger} instance.
* @param delegate the delegate.
* @param levelDelegate the {@link Logger} instance whose log level will be
* used.
*/
public Logger(java.util.logging.Logger delegate, Logger levelDelegate)
{
this.delegate = delegate;
this.levelDelegate = levelDelegate;
}
/**
* Sets the logging {@link Level} for this {@link Logger}.
* @param level the level to set.
*/
public void setLevel(Level level)
{
this.level = level;
}
/**
* @return the logging {@link Level} configured for this {@link Logger}.
*/
public Level getLevel()
{
return levelDelegate != null ? levelDelegate.getLevel() : level;
}
/**
* Checks whether messages with a particular level should be logged
* according to the log level configured for this {@link Logger}.
* @param level the log level.
*/
public boolean isLoggable(Level level)
{
Level currentLevel
= levelDelegate != null ? levelDelegate.getLevel() : this.level;
int levelValue = currentLevel.intValue();
return level.intValue() >= levelValue
&& levelValue != Level.OFF.intValue();
}
/**
* Logs a message at a given level, if that level is loggable according to
* the log level configured by this instance.
* @param level the level at which to log the message.
* @param msg the message to log.
*/
public void log(Level level, String msg)
{
if (isLoggable(level))
{
delegate.log(level, msg);
}
}
/**
* Logs a message at a given level, if that level is loggable according to
* the log level configured by this instance.
* @param level the level at which to log the message.
* @param msg the message to log.
* @param thrown a {@link Throwable} associated with log message.
*/
public void log(Level level, String msg, Throwable thrown)
{
if (isLoggable(level))
{
delegate.log(level, msg, thrown);
}
}
/**
* Logs a message with level {@link Level#SEVERE}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void severe(String msg)
{
log(Level.SEVERE, msg);
}
/**
* Logs a message with level {@link Level#WARNING}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void warning(String msg)
{
log(Level.WARNING, msg);
}
/**
* Logs a message with level {@link Level#INFO}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void info(String msg)
{
log(Level.INFO, msg);
}
/**
* Logs a message with level {@link Level#CONFIG}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void config(String msg)
{
log(Level.CONFIG, msg);
}
/**
* Logs a message with level {@link Level#FINE}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void fine(String msg)
{
log(Level.FINE, msg);
}
/**
* Logs a message with level {@link Level#FINER}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void finer(String msg)
{
log(Level.FINER, msg);
}
/**
* Logs a message with level {@link Level#FINEST}, if that level is
* loggable according to the log level configured for this {@link Logger}.
* @param msg the message to log.
*/
public void finest(String msg)
{
log(Level.FINEST, msg);
}
/**
* An alias for {@link #fine(String)}.
*/
public void debug(String msg)
{
fine(msg);
}
/**
* An alias for {@link #warning(String)}.
*/
public void warn(String msg)
{
warning(msg);
}
/**
* An alias for {@link #severe(String)}.
*/
public void error(String msg)
{
severe(msg);
}
/**
* An alias for {@link #finest(String)}.
*/
public void trace(String msg)
{
finest(msg);
}
}

View File

@ -0,0 +1,498 @@
/*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.util;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.Logger; // Disambiguation.
/**
* An abstract queue of packets. This is meant to eventually be able to be used
* in the following classes (in ice4j and libjitsi) in place of their ad-hoc
* queue implementations (which is the reason the class is parameterized):
* <br> RTPConnectorOutputStream.Queue
* <br> PushSourceStreamImpl#readQ
* <br> OutputDataStreamImpl#writeQ
* <br> SinglePortHarvester.MySocket#queue
* <br> MultiplexingSocket#received (and the rest of Multiplex* classes).
*
* @author Boris Grozev
*/
public abstract class PacketQueue<T>
{
/**
* The {@link Logger} used by the {@link PacketQueue} class and its
* instances for logging output.
*/
private static final Logger logger
= Logger.getLogger(PacketQueue.class.getName());
/**
* The default capacity of a {@link PacketQueue}.
*/
private final static int DEFAULT_CAPACITY = 256;
/**
* The capacity of the {@code byte[]} cache, if it is enabled.
*/
private final static int CACHE_CAPACITY = 100;
/**
* Returns true if a warning should be logged after a queue has dropped
* {@code numDroppedPackets} packets.
* @param numDroppedPackets the number of dropped packets.
* @return {@code true} if a warning should be logged.
*/
public static boolean logDroppedPacket(int numDroppedPackets)
{
return
numDroppedPackets == 1 ||
(numDroppedPackets <= 1000 && numDroppedPackets % 100 == 0) ||
numDroppedPackets % 1000 == 0;
}
/**
* The underlying {@link Queue} which holds packets.
*/
private final Queue<T> queue;
/**
* Whether this {@link PacketQueue} should store the {@code byte[]} or
* {@code T} instances added to it via one of the {@code add} methods (if
* {@code false}), or create and store a copy (if {@code true}).
*/
private final boolean copy;
/**
* The capacity of this {@link PacketQueue}. If one of the {@code add}
* methods is called while the queue holds this many packets, the first
* packet in the queue will be dropped.
*/
private final int capacity;
/**
* The {@link QueueStatistics} instance optionally used to collect and print
* detailed statistics about this queue.
*/
private final QueueStatistics queueStatistics;
/**
* The {@link Thread} optionally used to perpetually read packets from this
* queue and handle them using {@link #handler}.
*/
private final Thread thread;
/**
* The {@link org.ice4j.util.PacketQueue.PacketHandler} optionally used to
* handle packets read from this queue by {@link #thread}.
*/
private final PacketHandler<T> handler;
/**
* A string used to identify this {@link PacketQueue} for logging purposes.
*/
private final String id;
/**
* Whether this queue has been closed.
*/
private boolean closed = false;
/**
* The number of packets which were dropped from this {@link PacketQueue} as
* a result of a packet being added while the queue is at full capacity.
*/
private int numDroppedPackets = 0;
/**
* Initializes a new {@link PacketQueue} instance.
*/
public PacketQueue()
{
this(false, "PacketQueue", null);
}
/**
* Initializes a new {@link PacketQueue} instance.
* @param enableStatistics whether detailed statistics should be calculated
* and printed. WARNING: this will produce copious output (one line per
* packet added or removed).
* @param id the ID of the packet queue, to be used for logging.
* @param packetHandler An optional handler to be used by the queue for
* packets read from it. If a non-null value is passed the queue will
* start its own thread, which will read packets from the queue and execute
* {@code handler.handlePacket} on them. If set to null, no thread will be
* created, and the queue will provide access to the head element via
* {@link #get()} and {@link #poll()}.
*/
public PacketQueue(
boolean enableStatistics, String id, PacketHandler<T> packetHandler)
{
this(DEFAULT_CAPACITY, true, enableStatistics, id, packetHandler);
}
/**
* Initializes a new {@link PacketQueue} instance.
* @param capacity the capacity of the queue.
* @param copy whether the queue is to store the instances it is given via
* the various {@code add} methods, or create a copy.
* @param enableStatistics whether detailed statistics should be calculated
* and printed. WARNING: this will produce copious output (one line per
* packet added or removed).
* @param id the ID of the packet queue, to be used for logging.
* @param packetHandler An optional handler to be used by the queue for
* packets read from it. If a non-null value is passed the queue will
* start its own thread, which will read packets from the queue and execute
* {@code handler.handlePacket} on them. If set to null, no thread will be
* created, and the queue will provide access to the head element via
* {@link #get()} and {@link #poll()}.
*/
public PacketQueue(int capacity, boolean copy,
boolean enableStatistics, String id,
PacketHandler<T> packetHandler)
{
this.copy = copy;
this.capacity = capacity;
this.id = id;
queue = new ArrayBlockingQueue<>(capacity);
queueStatistics
= enableStatistics ? new QueueStatistics(id) : null;
if (packetHandler != null)
{
handler = packetHandler;
thread = new Thread(){
@Override
public void run()
{
runInReadingThread();
}
};
thread.setName(getClass().getName() + "-" + id);
thread.setDaemon(true);
thread.start();
}
else
{
thread = null;
handler = null;
}
logger.fine("Initialized a PacketQueue instance with ID " + id);
}
/**
* Perpetually reads packets from this {@link PacketQueue} and uses
* {@link #handler} on each of them.
*/
private void runInReadingThread()
{
if (Thread.currentThread() != thread)
{
logger.warning("runInReadingThread executing in "
+ Thread.currentThread());
return;
}
if (handler == null)
{
logger.warning("No handler set, the reading thread will be stopped.");
return;
}
while (!closed)
{
T pkt;
synchronized (queue)
{
pkt = queue.poll();
if (pkt == null)
{
try
{
queue.wait(100);
}
catch (InterruptedException ie)
{
}
continue;
}
}
if (queueStatistics != null)
{
queueStatistics.remove(System.currentTimeMillis());
}
try
{
handler.handlePacket(pkt);
}
catch (Exception e)
{
logger.warning("Failed to handle packet: " + e);
}
}
}
/**
* Adds a packet represented by a {@code byte[]} with a corresponding
* offset and length to this queue.
* @param buf the {@code byte[]} to add.
* @param off the offset into {@code byte[]} where data begins.
* @param len the length of the data.
*/
public void add(byte[] buf, int off, int len)
{
add(buf, off, len, null);
}
/**
* Adds a packet represented by a {@code byte[]} with a corresponding
* offset and length, and a context object to this queue.
* @param buf the {@code byte[]} to add.
* @param off the offset into {@code byte[]} where data begins.
* @param len the length of the data.
* @param context an object which will be added to the queue as part of the
* packet.
*/
public void add(byte[] buf, int off, int len, Object context)
{
if (copy)
{
byte[] newBuf = getByteArray(len);
System.arraycopy(buf, off, newBuf, 0, len);
doAdd(createPacket(newBuf, 0, len, context));
}
else
{
doAdd(createPacket(buf, off, len, context));
}
}
/**
* Adds a specific packet ({@code T}) instance to the queue.
* @param pkt the packet to add.
*/
public void add(T pkt)
{
if (copy)
{
// create a new instance
add(getBuffer(pkt), getOffset(pkt), getLength(pkt), getContext(pkt));
}
else
{
doAdd(pkt);
}
}
/**
* Get an unused {@link byte[]} instance with length at least {@code len}.
* @param len the minimum length of the returned instance.
* @return a {@link byte[]} instance with length at least {@code len}.
*/
private byte[] getByteArray(int len)
{
return new byte[len];
}
/**
* Adds a specific packet ({@code T}) instance to the queue.
* @param pkt the packet to add.
*/
private void doAdd(T pkt)
{
if (closed)
return;
synchronized (queue)
{
if (queue.size() >= capacity)
{
// Drop from the head of the queue.
T p = queue.poll();
if (p != null)
{
if (queueStatistics != null)
{
queueStatistics.remove(System.currentTimeMillis());
}
if (logDroppedPacket(++numDroppedPackets))
{
logger.warning(
"Packets dropped (id=" + id + "): " + numDroppedPackets);
}
}
}
if (queueStatistics != null)
{
queueStatistics.add(System.currentTimeMillis());
}
queue.offer(pkt);
queue.notifyAll();
}
}
/**
* Removes and returns the packet ({@code T}) at the head of this queue.
* Blocks until there is a packet in the queue. Returns {@code null} if
* the queue is closed or gets closed while waiting for a packet to be added.
* @return the packet at the head of this queue.
*/
public T get()
{
if (handler != null)
{
// If the queue was configured with a handler, it is running its
// own reading thread, and reading from it via this interface would
// not provide consistent results.
throw new IllegalStateException(
"Trying to read from a queue with a configured handler.");
}
while (true)
{
if (closed)
return null;
synchronized (queue)
{
T pkt = queue.poll();
if (pkt != null)
{
if (queueStatistics != null)
{
queueStatistics.remove(System.currentTimeMillis());
}
return pkt;
}
try
{
queue.wait();
}
catch (InterruptedException ie)
{}
}
}
}
/**
* Removes and returns the packet ({@code T}) at the head of this queue, if
* the queue is non-empty. If the queue is closed or empty, returns null
* without blocking.
* @return the packet at the head of this queue, or null if the queue is
* empty.
*/
public T poll()
{
if (closed)
return null;
if (handler != null)
{
// If the queue was configured with a handler, it is running its
// own reading thread, and reading from it via this interface would
// not provide consistent results.
throw new IllegalStateException(
"Trying to read from a queue with a configured handler.");
}
synchronized (queue)
{
T pkt = queue.poll();
if (pkt != null && queueStatistics != null)
{
queueStatistics.remove(System.currentTimeMillis());
}
return pkt;
}
}
public void close()
{
if (!closed)
{
closed = true;
synchronized (queue)
{
queue.notifyAll();
}
}
}
/**
* Extracts the underlying {@code byte[]} from a packet.
* @param pkt the packet to get the {@code byte[]} from.
* @return the underlying {@code byte[]} of {@code pkt}.
*/
public abstract byte[] getBuffer(T pkt);
/**
* Extracts the offset of a packet.
* @param pkt the packet to get the offset of.
* @return the offset of {@code pkt}.
*/
public abstract int getOffset(T pkt);
/**
* Extracts the length of a packet.
* @param pkt the packet to get the length of.
* @return the length of {@code pkt}.
*/
public abstract int getLength(T pkt);
/**
* Extracts the context of a packet.
* @param pkt the packet to get the context of.
* @return the context of {@code pkt}.
*/
public abstract Object getContext(T pkt);
/**
* Creates a new packet ({@link T} instance) with the given {@code byte[]},
* offset, length and context.
* @param buf the {@code byte[]} of the new instance.
* @param off the offset of the new instance.
* @param len the length of the new instance.
* @param context the context of the new instance.
* @return a new packet ({@link T} instance).
*/
protected abstract T createPacket(
byte[] buf, int off, int len, Object context);
/**
* A simple interface to handle packets.
* @param <T> the type of the packets.
*/
public interface PacketHandler<T>
{
/**
* Does something with a packet.
* @param pkt the packet to do something with.
* @return {@code true} if the operation was successful, and
* {@code false} otherwise.
*/
boolean handlePacket(T pkt);
}
}

View File

@ -1,263 +0,0 @@
package org.ice4j.util;
import org.jitsi.utils.logging2.*;
import java.time.*;
import java.util.concurrent.*;
/**
* A base class for runnables which should be periodically executed on
* specified executor service.
*
* @author Yura Yaroshevich
*/
public abstract class PeriodicRunnable
{
/**
* The {@link Logger} used by the {@link PeriodicRunnable} class for logging output.
*/
private final static Logger logger = new LoggerImpl(PeriodicRunnable.class.getName());
/**
* A timer to perform periodic scheduling of {@link #run()} execution
* on {@link #executor}'s thread.
*/
private final ScheduledExecutorService timer;
/**
* An executor service to perform actual execution of {@link #run()}.
*/
private final ExecutorService executor;
/**
* A synchronization object to synchronize scheduling, execution and
* cancellation of {@link #run()}.
*/
private final Object syncRoot = new Object();
/**
* Indicates if execution of {@link #run()} scheduled and should
* be further continued.
*/
private volatile boolean running = false;
/**
* Store a reference to last runnable submitted to {@link #timer}
*/
private ScheduledFuture<?> scheduledSubmit;
/**
* Store a reference to last runnable submitted to {@link #executor}
*/
private Future<?> submittedExecute;
/**
* Create instance of {@link PeriodicRunnable} with specified timer and
* executor.
* @param timer an {@link ScheduledExecutorService} which is used to
* periodic triggering of {@link #run()} execution.
* @param executor an {@link ExecutorService} to perform actual execution
* of {@link #run()}.
*/
protected PeriodicRunnable(
ScheduledExecutorService timer,
ExecutorService executor)
{
if (timer == null)
{
throw new IllegalArgumentException("timer is null");
}
if (executor == null)
{
throw new IllegalArgumentException("executor is null");
}
this.timer = timer;
this.executor = executor;
}
/**
* Get delay before next execution of {@link #run()}.
* @return non-negative value if execution of {@link #run()} should be
* performed with specified delay, negative value if execution should not
* be done.
*/
protected abstract Duration getDelayUntilNextRun();
/**
* Periodically executed method on {@link #executor}'s thread.
*/
protected abstract void run();
/**
* Schedules periodic execution of {@link #run()} on {@link #executor}'s
* thread.
*/
public void schedule()
{
if (running)
{
return;
}
final Duration delay =
getDelayUntilNextRun();
scheduleNextRun(delay);
}
/**
* Cancels periodic execution of {@link #run()} on {@link #executor}'s
* thread.
*/
public void cancel()
{
if (!running)
{
return;
}
synchronized (syncRoot)
{
if (running)
{
running = false;
if (scheduledSubmit != null)
{
scheduledSubmit.cancel(true);
scheduledSubmit = null;
}
if (submittedExecute != null)
{
submittedExecute.cancel(true);
submittedExecute = null;
}
}
}
}
/**
* Perform either cancellation or actual scheduling based on delay until
* next run.
* @param delay delay before next execution of {@link #run()}.
*/
private void scheduleNextRun(Duration delay)
{
synchronized (syncRoot)
{
final boolean isRecurrentRun = submittedExecute != null;
if (isRecurrentRun && !running)
{
// was cancelled
return;
}
if (delay.isNegative())
{
running = false;
scheduledSubmit = null;
submittedExecute = null;
return;
}
running = true;
if (delay.isZero())
{
submitExecuteRun();
}
else
{
scheduledSubmit = timer.schedule(
this::submitExecuteRun,
delay.toNanos(),
TimeUnit.NANOSECONDS);
}
}
}
/**
* Submit execution of {@link #run()} into {@link #executor}'s thread
* if not cancelled.
*/
private void submitExecuteRun()
{
if (!running)
{
return;
}
synchronized (syncRoot)
{
if (!running)
{
return;
}
submittedExecute = this.executor.submit(this::executeRun);
}
}
/**
* Perform execution of {@link #run()} with further re-schedule of
* execution if not cancelled
*/
private void executeRun()
{
if (!running)
{
return;
}
try
{
this.run();
}
catch (Exception e)
{
logger.warn("Exception in run(), will retry.", e);
}
finally
{
if (running)
{
final Duration delayMillis =
getDelayUntilNextRun();
scheduleNextRun(delayMillis);
}
}
}
/**
* Constructs {@link PeriodicRunnable} for {@link Runnable} with provided
* timer, executor and fixed delay.
* fixed delay.
* @param timer {@link ScheduledExecutorService} to be used as timer
* @param executor {@link ExecutorService} to execute provided runnable
* @param period delay between subsequent execution of runnable
* @param r {@link Runnable} to for periodic execution.
* @return {@link PeriodicRunnable} instance constructed with provided
* arguments
*/
static PeriodicRunnable create(
ScheduledExecutorService timer,
ExecutorService executor,
Duration period,
Runnable r)
{
return new PeriodicRunnable(timer, executor)
{
@Override
protected Duration getDelayUntilNextRun()
{
return period;
}
@Override
protected void run()
{
r.run();
}
};
}
}

View File

@ -0,0 +1,131 @@
/*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.util;
import java.util.logging.*;
import java.util.logging.Logger; // Disambiguation.
public class QueueStatistics
{
/**
* The scale to use for {@link RateStatistics}. This makes their output in
* units (e.g. packets) per second.
*/
private static final int SCALE = 1000;
/**
* The interval (in number of calls to {@link #add(long)} or
* {@link #remove(long)}) at which the gathered statistics will be printed.
*/
private static final int DEFAULT_PRINT_INTERVAL = 500;
/**
* Calculate the average rate of addition of packets in a 200ms window.
*/
private final RateStatistics addRateStatistics = new RateStatistics(200, SCALE);
/**
* Calculate the average rate of removal of packets in a 200ms window.
*/
private final RateStatistics removeRateStatistics = new RateStatistics(200, SCALE);
/**
* The {@link Logger} instance used for logging output.
*/
private final Logger logger;
private int head = 0;
private int size = 0;
private int[] sizes = new int[DEFAULT_PRINT_INTERVAL];
private long[] timestamps = new long[DEFAULT_PRINT_INTERVAL];
private long[] addRates = new long[DEFAULT_PRINT_INTERVAL];
private long[] removeRates = new long[DEFAULT_PRINT_INTERVAL];
private int[] totalPacketsAddedHistory = new int[DEFAULT_PRINT_INTERVAL];
private int totalPacketsAdded = 0;
private String logHeader;
/**
* Initializes a new {@link QueueStatistics} instance.
*
* @param id Identifier to distinguish the log output of multiple
* {@link QueueStatistics} instances.
*/
public QueueStatistics(String id)
{
logger = Logger.getLogger("QueueStatistics-" + id);
logHeader = "QueueStatistics-" + id + ": ";
// We let the users of this class decide whether to enable logging (by
// creating a QueueStatistic instance) or not.
logger.setLevel(Level.ALL);
}
/**
* Registers the addition of a packet to the corresponding queue.
* @param now the time (in milliseconds since the epoch) at which the
* packet was added.
*/
public synchronized void add(long now)
{
addRateStatistics.update(1, now);
size++;
totalPacketsAdded++;
update(now);
}
/**
* Registers the removal of a packet from the corresponding queue.
* @param now the time (in milliseconds since the epoch) at which the
* packet was removed.
*/
public synchronized void remove(long now)
{
removeRateStatistics.update(1, now);
size--;
update(now);
}
private synchronized void update(long now)
{
if (head == sizes.length)
{
print();
head = 0;
}
sizes[head] = size;
timestamps[head] = now;
addRates[head] = addRateStatistics.getRate(now);
removeRates[head] = removeRateStatistics.getRate(now);
totalPacketsAddedHistory[head] = totalPacketsAdded;
head++;
}
private void print()
{
StringBuilder s = new StringBuilder();
for (int i =0; i<sizes.length; i++)
{
s.append(logHeader).
append(timestamps[i]).append(' ').
append(sizes[i]).append(' ').
append(addRates[i]).append(' ').
append(removeRates[i]).append(' ').
append(totalPacketsAddedHistory[i]).append('\n');
}
logger.fine(s.toString());
}
}

View File

@ -0,0 +1,146 @@
/*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.util;
/**
* This originally comes from webrtc.org but has been moved here so that it can
* be reused more easily.
*
* webrtc/modules/remote_bitrate_estimator/rate_statistics.cc
* webrtc/modules/remote_bitrate_estimator/rate_statistics.h
*
* @author Lyubomir Marinov
*/
public class RateStatistics
{
/**
* Total count recorded in buckets.
*/
private long accumulatedCount;
/**
* Counters are kept in buckets (circular buffer), with one bucket per
* millisecond.
*/
private final long[] buckets;
/**
* Bucket index of oldest counter recorded in buckets.
*/
private int oldestIndex;
/**
* Oldest time recorded in buckets.
*/
private long oldestTime;
/**
* To convert counts/ms to desired units.
*/
private final float scale;
/**
* Initializes a new {@link RateStatistics} instance with a default scale
* of 8000 (i.e. if the input is in bytes, the result will be in bits per
* second).
* @param windowSizeMs window size in ms for the rate estimation
*/
public RateStatistics(int windowSizeMs)
{
this(windowSizeMs, 8000F);
}
/**
* @param windowSizeMs window size in ms for the rate estimation
* @param scale coefficient to convert counts/ms to desired units. For
* example, if counts represents bytes, use <tt>8*1000</tt> to go to bits/s.
*/
public RateStatistics(int windowSizeMs, float scale)
{
buckets = new long[windowSizeMs + 1]; // N ms in (N+1) buckets.
this.scale = scale / (buckets.length - 1);
}
private synchronized void eraseOld(long nowMs)
{
long newOldestTime = nowMs - buckets.length + 1;
if (newOldestTime <= oldestTime)
return;
while (oldestTime < newOldestTime)
{
long countInOldestBucket = buckets[oldestIndex];
accumulatedCount -= countInOldestBucket;
buckets[oldestIndex] = 0L;
if (++oldestIndex >= buckets.length)
{
oldestIndex = 0;
}
++oldestTime;
if (accumulatedCount == 0L)
{
// This guarantees we go through all the buckets at most once,
// even if newOldestTime is far greater than oldestTime.
break;
}
}
oldestTime = newOldestTime;
}
public long getRate()
{
return getRate(System.currentTimeMillis());
}
public long getRate(long nowMs)
{
eraseOld(nowMs);
return (long) (accumulatedCount * scale + 0.5F);
}
public long getAccumulatedCount()
{
return getAccumulatedCount(System.currentTimeMillis());
}
public long getAccumulatedCount(long nowMs)
{
eraseOld(nowMs);
return accumulatedCount;
}
public void update(int count, long nowMs)
{
if (nowMs < oldestTime) // Too old data is ignored.
return;
synchronized (this)
{
eraseOld(nowMs);
int nowOffset = (int) (nowMs - oldestTime);
int index = oldestIndex + nowOffset;
if (index >= buckets.length)
index -= buckets.length;
buckets[index] += count;
accumulatedCount += count;
}
}
}

View File

@ -1,83 +0,0 @@
/*
* Copyright @ 2020 - Present, 8x8 Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.ice
import org.jitsi.metaconfig.config
import java.time.Duration
import org.jitsi.config.JitsiConfig.Companion.newConfig as configSource
class AgentConfig {
val consentFreshnessInterval: Duration by config {
"org.ice4j.ice.CONSENT_FRESHNESS_INTERVAL".from(configSource)
.convertFrom<Long> { Duration.ofMillis(it) }
"ice4j.consent-freshness.interval".from(configSource)
}
val randomizeConsentFreshnessInterval: Boolean by config {
"ice4j.consent-freshness.randomize-interval".from(configSource)
}
val consentFreshnessOriginalWaitInterval: Duration by config {
"org.ice4j.ice.CONSENT_FRESHNESS_WAIT_INTERVAL".from(configSource)
.convertFrom<Long> { Duration.ofMillis(it) }
"ice4j.consent-freshness.original-wait-interval".from(configSource)
}
val consentFreshnessMaxWaitInterval: Duration by config {
"org.ice4j.ice.CONSENT_FRESHNESS_MAX_WAIT_INTERVAL".from(configSource)
.convertFrom<Long> { Duration.ofMillis(it) }
"ice4j.consent-freshness.max-wait-interval".from(configSource)
}
val maxConsentFreshnessRetransmissions: Int by config {
"org.ice4j.ice.CONSENT_FRESHNESS_MAX_RETRANSMISSIONS".from(configSource)
"ice4j.consent-freshness.max-retransmissions".from(configSource)
}
val terminationDelay: Duration by config {
"org.ice4j.TERMINATION_DELAY".from(configSource)
.convertFrom<Long> { Duration.ofMillis(it) }
"ice4j.ice.termination-delay".from(configSource)
}
val maxCheckListSize: Int by config {
"org.ice4j.MAX_CHECK_LIST_SIZE".from(configSource)
"ice4j.ice.max-check-list-size".from(configSource)
}
/** The value of the SOFTWARE attribute that ice4j should include in all outgoing messages. */
val software: String? by config {
"org.ice4j.SOFTWARE".from(configSource)
"ice4j.software".from(configSource)
}
/**
* Whether the per-component merging socket should be enabled by default (the default value can be
* overridden with the [Agent] API).
* If enabled, the user of the library must use the socket instance provided by [Component.getSocket]. Otherwise,
* the socket instance from the desired [CandidatePair] must be used.
*/
val useComponentSocket: Boolean by config {
"org.ice4j.ice.USE_COMPONENT_SOCKET".from(configSource)
"ice4j.use-component-socket".from(configSource)
}
companion object {
@JvmField
val config = AgentConfig()
}
}

View File

@ -1,132 +0,0 @@
/*
* Copyright @ 2020 - Present, 8x8 Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.ice.harvest
import com.typesafe.config.Config
import org.jitsi.metaconfig.ConfigException
import org.jitsi.metaconfig.config
import org.jitsi.metaconfig.optionalconfig
import java.time.Duration
import org.jitsi.config.JitsiConfig.Companion.newConfig as configSource
class HarvestConfig {
val useLinkLocalAddresses: Boolean by config {
"org.ice4j.ice.harvest.DISABLE_LINK_LOCAL_ADDRESSES".from(configSource)
.transformedBy { !it }
"ice4j.harvest.use-link-local-addresses".from(configSource)
}
fun useLinkLocalAddresses() = useLinkLocalAddresses
val udpReceiveBufferSize: Int? by optionalconfig {
"org.ice4j.ice.harvest.AbstractUdpListener.SO_RCVBUF".from(configSource)
"ice4j.harvest.udp.receive-buffer-size".from(configSource)
}
fun udpReceiveBufferSize() = udpReceiveBufferSize
val useIpv6: Boolean by config {
"org.ice4j.ipv6.DISABLED".from(configSource)
.transformedBy { !it }
"ice4j.harvest.use-ipv6".from(configSource)
}
fun useIpv6() = useIpv6
val useDynamicPorts: Boolean by config {
"org.ice4j.ice.harvest.USE_DYNAMIC_HOST_HARVESTER".from(configSource)
"ice4j.harvest.udp.use-dynamic-ports".from(configSource)
}
fun useDynamicPorts() = useDynamicPorts
val timeout: Duration by config {
"org.ice4j.ice.harvest.HARVESTING_TIMEOUT".from(configSource)
.convertFrom<Long> { Duration.ofSeconds(it) }
"ice4j.harvest.timeout".from(configSource)
}
fun timeout() = timeout
val stunMappingCandidateHarvesterAddresses: List<String> by config {
"org.ice4j.ice.harvest.STUN_MAPPING_HARVESTER_ADDRESSES".from(configSource)
.convertFrom<String> { it.split(",") }
"ice4j.harvest.mapping.stun.addresses".from(configSource)
}
fun stunMappingCandidateHarvesterAddresses() = stunMappingCandidateHarvesterAddresses
val enableAwsHarvester: Boolean by config {
"org.ice4j.ice.harvest.DISABLE_AWS_HARVESTER".from(configSource).transformedBy { !it }
"ice4j.harvest.mapping.aws.enabled".from(configSource)
}
fun enableAwsHarvester() = enableAwsHarvester
val forceAwsHarvester: Boolean by config {
"org.ice4j.ice.harvest.FORCE_AWS_HARVESTER".from(configSource).transformedBy { !it }
"ice4j.harvest.mapping.aws.force".from(configSource)
}
fun forceAwsHarvester() = enableAwsHarvester
private val legacyNatHarvesterLocalAddress: String? by optionalconfig {
"org.ice4j.ice.harvest.NAT_HARVESTER_LOCAL_ADDRESS".from(configSource)
}
private val legacyNatHarvesterPublicAddress: String? by optionalconfig {
"org.ice4j.ice.harvest.NAT_HARVESTER_PUBLIC_ADDRESS".from(configSource)
}
private val staticMappingsFromNewConfig: Set<StaticMapping> by config {
"ice4j.harvest.mapping.static-mappings".from(configSource)
.convertFrom<List<Config>> { cfg ->
cfg.map {
val localPort = if (it.hasPath("local-port")) it.getInt("local-port") else null
val publicPort = if (it.hasPath("public-port")) it.getInt("public-port") else null
if ((localPort == null || publicPort == null) && localPort != publicPort) {
throw ConfigException.UnableToRetrieve.ConditionNotMet(
"Inconsistent value for local-port and public-port, both must be present or both missing."
)
}
StaticMapping(
localAddress = it.getString("local-address"),
publicAddress = it.getString("public-address"),
localPort = localPort,
publicPort = publicPort,
name = if (it.hasPath("name")) it.getString("name") else null
)
}.toSet()
}
}
val staticMappings: Set<StaticMapping> = let {
if (legacyNatHarvesterLocalAddress != null && legacyNatHarvesterPublicAddress != null) {
setOf(
StaticMapping(legacyNatHarvesterLocalAddress!!, legacyNatHarvesterPublicAddress!!),
*staticMappingsFromNewConfig.toTypedArray()
)
} else {
staticMappingsFromNewConfig
}
}
data class StaticMapping(
val localAddress: String,
val publicAddress: String,
val localPort: Int? = null,
val publicPort: Int? = null,
val name: String? = null
)
companion object {
@JvmField
val config = HarvestConfig()
}
}

View File

@ -1,104 +0,0 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.ice.harvest
import org.ice4j.TransportAddress
import org.ice4j.ice.CandidateExtendedType
import org.ice4j.ice.Component
import org.ice4j.ice.HostCandidate
import org.ice4j.ice.LocalCandidate
import org.ice4j.ice.ServerReflexiveCandidate
/**
* A [CandidateHarvester] which maps existing local [HostCandidate]s to new candidates.
*/
abstract class MappingCandidateHarvester @JvmOverloads constructor(
val name: String,
/**
* Whether this harvester should match the port of the public address.
*
* When [matchPort] is enabled, mapping candidates will be added only when the local host candidate's address and
* port match the public (mask) address, and the public (mask) address's port will be used.
*
* When [matchPort] is disabled, mapping candidates will be added whenever the local host candidate's inet address
* matches the public (mask) address, and the host candidate port will be preserved.
*/
val matchPort: Boolean = false
) : AbstractCandidateHarvester() {
abstract val face: TransportAddress?
abstract val mask: TransportAddress?
/**
* Checks whether the given [address] matches the public address of this harvester.
* only compares the inet address (since by default the port is not matched in [harvest]), but other implementations
* may chose to also compare the port.
*/
fun publicAddressMatches(address: TransportAddress): Boolean {
val mask = this.mask
return if (mask == null) {
false
} else {
mask.address == address.address && (!matchPort || mask.port == address.port)
}
}
/**
* Looks for existing [HostCandidate]s in [component] which match our local address ([face]) and creates
* associated [ServerReflexiveCandidate]s substituting [mask] for the address.
*
* @param component the [Component] that we'd like to harvest candidates for.
* @return the [LocalCandidate]s created and added to [component].
*/
override fun harvest(component: Component): Collection<LocalCandidate> {
val localAddress = face ?: return emptyList()
val publicAddress = mask ?: return emptyList()
// Report the LocalCandidates gathered by this CandidateHarvester so
// that the harvest is sure to be considered successful.
val candidates = mutableSetOf<LocalCandidate>()
component.localCandidates
.filter {
it is HostCandidate &&
it.transportAddress.hostAddress == localAddress.hostAddress &&
it.transport == localAddress.transport &&
(!matchPort || it.transportAddress.port == localAddress.port)
}.forEach { hostCandidate ->
hostCandidate as HostCandidate
val mappedAddress = TransportAddress(
publicAddress.hostAddress,
if (matchPort) publicAddress.port else hostCandidate.hostAddress.port,
hostCandidate.hostAddress.transport
)
val mappedCandidate = ServerReflexiveCandidate(
mappedAddress,
hostCandidate,
hostCandidate.stunServerAddress,
CandidateExtendedType.STATICALLY_MAPPED_CANDIDATE
)
if (hostCandidate.isSSL) mappedCandidate.isSSL = true
// Try to add the candidate to the component and only then add it to the harvest.
if (!candidates.contains(mappedCandidate) && component.addLocalCandidate(mappedCandidate)) {
candidates.add(mappedCandidate)
}
}
return candidates
}
}

View File

@ -1,29 +0,0 @@
package org.ice4j.ice.harvest
import org.ice4j.TransportAddress
/**
* Uses a predefined static mask in order to generate [TransportAddress]es. This harvester is meant for use in
* situations where servers are deployed behind a NAT or in a DMZ with static port mapping.
*
* Every time the [.harvest] method is called, the mapping harvester will return a list of candidates that provide
* masked alternatives for every host candidate in the component. Kind of like a STUN server.
*
* Example: You run this on a server with address 192.168.0.1, that is behind a NAT with public IP: 93.184.216.119.
* You allocate a host candidate 192.168.0.1/UDP/5000. This harvester is going to then generate an address
* 93.184.216.119/UDP/5000.
*
* This harvester is instant and does not introduce any harvesting latency.
*
* @author Emil Ivov
*/
class StaticMappingCandidateHarvester @JvmOverloads constructor(
/** The public address (aka mask) */
override val mask: TransportAddress,
/** The local address (aka face) */
override val face: TransportAddress,
name: String? = null,
matchPort: Boolean = false
) : MappingCandidateHarvester(name ?: "static_mapping", matchPort) {
override fun toString() = "${javaClass.name}(face=$face, mask=$mask)"
}

View File

@ -1,94 +0,0 @@
ice4j {
ice {
max-check-list-size = 100
// The amount of time that we must wait after ICE processing enters a COMPLETED state before we free candidates
// and move into the TERMINATED state.
termination-delay = 3 seconds
}
// The value of the SOFTWARE attribute that ice4j should include in all outgoing messages. Set to the empty string to
// not include a SOFTWARE attribute.
software = "ice4j.org"
// Whether the per-component merging socket should be enabled by default (the default value can be
// overridden with the [Agent] API).
// If enabled, the user of the library must use the socket instance provided by [Component.getSocket]. Otherwise,
// the socket instance from the desired [CandidatePair] must be used.
use-component-socket = true
consent-freshness {
// How often a STUN Binding request used for consent freshness check will be sent.
interval = 15 seconds
// The amount of time without a valid STUN Binding response after which a STUN Binding request is to be
// retransmitted according to `STUN Usage for Consent Freshness` (RFC7675).
// This is the original value for back-off strategy, while `max-wait-interval` sets the upper limit.
original-wait-interval = 500 milliseconds
// The amount of time without a valid STUN Binding response after which a STUN Binding request is to be
// retransmitted according to `STUN Usage for Consent Freshness` (RFC7675).
// This is the final value for the back-off strategy, while `original-wait-interval` defines the initial interval for
// the first request sent.
max-wait-interval = 500 milliseconds
// The maximum number of retransmissions of a STUN Binding request without a valid STUN Binding response after which
// consent freshness is to be considered unconfirmed according to `STUN Usage for Consent Freshness` (RFC7675).
max-retransmissions = 30
// Whether to randomize the period between any two checks between 0.8 and 1.2 of the configured interval as
// recommended in RFC7675 Section 5.1. We keep this configurable in case the previous behavior is desired.
randomize-interval = true
}
// Configuration related to harvesting (aka gathering) of local candidates.
harvest {
// Whether to harvest IPv6 addresses.
use-ipv6 = true
// Whether to use link-local addresses when harvesting candidates.
use-link-local-addresses = true
// How long to wait for an individual harvest before timing out.
timeout = 15 seconds
// Configuration for the "single port" UDP harvester.
udp {
// The size in bytes to set on the UDP socket (SO_RCVBUF). If not specified, the default from the OS will be used.
#receive-buffer-size = 10485760
// Whether to allocate ephemeral ports for local candidates. This is the default value, and can be overridden
// for Agent instances.
use-dynamic-ports = true
}
// Configuration for the set of "mapping" harvesters.
mapping {
aws {
enabled = true
// Whether to use the AWS harvester even when the automatic detection indicates that we are not running in AWS.
force = false
}
stun {
addresses = [ ]
# addresses = [ "stun1.example.com:5379", "stun2.example.com:443" ]
}
// Pre-configured mappings
static-mappings = [
#{
# // This results in a candidate for 1.2.3.4:20000 being added whenever a host candidate for
# // 10.10.0.123:10000 exists.
# local-address = "10.10.0.123"
# public-address = "1.2.3.4"
# // The ports are optional, but need to either both be provided or both not provided.
# local-port = 10000
# public-port = 20000
# // Optional name
# name = "my-mapping-for-a-specific-port"
#},
#{
# // This results in a candidate for 1.2.3.4:PORT being added whenever a host candidate for 10.10.0.123
# // exists, where the PORT is the port of the existing host candidate.
# local-address = "10.10.0.123"
# public-address = "1.2.3.4"
# // Optional name
# name = "my-mapping-for-all-ports"
#}
]
}
}
}

View File

@ -19,18 +19,18 @@ package org.ice4j;
import java.util.*;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import org.ice4j.message.*;
import org.ice4j.socket.*;
import org.ice4j.stack.*;
import org.junit.jupiter.api.*;
/**
* Test event dispatching for both client and server.
*`
* @author Emil Ivov
*/
public class MessageEventDispatchingTest
public class MessageEventDispatchingTest extends TestCase
{
/**
* The stack that we are using for the tests.
@ -95,9 +95,10 @@ public class MessageEventDispatchingTest
*
* @throws Exception if anything goes wrong.
*/
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
stunStack = new StunStack();
clientSock = new IceUdpSocketWrapper(
@ -125,8 +126,7 @@ public class MessageEventDispatchingTest
*
* @throws Exception if anything goes wrong.
*/
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
stunStack.removeSocket(clientAddress);
stunStack.removeSocket(serverAddress);
@ -138,6 +138,8 @@ public class MessageEventDispatchingTest
requestCollector = null;
responseCollector = null;
super.tearDown();
}
/**
@ -145,7 +147,6 @@ public class MessageEventDispatchingTest
*
* @throws Exception upon a stun failure
*/
@Test
public void testClientTransactionTimeouts() throws Exception
{
String oldRetransValue = System.getProperty(
@ -155,11 +156,13 @@ public class MessageEventDispatchingTest
responseCollector);
responseCollector.waitForTimeout();
assertEquals(1, responseCollector.receivedResponses.size(),
"No timeout was produced upon expiration of a client transaction");
assertEquals(
"No timeout was produced upon expiration of a client transaction",
responseCollector.receivedResponses.size(), 1);
assertEquals("timeout", responseCollector.receivedResponses.get(0),
"No timeout was produced upon expiration of a client transaction");
assertEquals(
"No timeout was produced upon expiration of a client transaction",
responseCollector.receivedResponses.get(0), "timeout");
//restore the retransmissions prop in case others are counting on
//defaults.
@ -175,7 +178,6 @@ public class MessageEventDispatchingTest
*
* @throws java.lang.Exception upon any failure
*/
@Test
public void testEventDispatchingUponIncomingRequests() throws Exception
{
//prepare to listen
@ -187,8 +189,8 @@ public class MessageEventDispatchingTest
requestCollector.waitForRequest();
//verify
assertEquals(1, requestCollector.receivedRequests.size(),
"No MessageEvents have been dispatched");
assertTrue("No MessageEvents have been dispatched",
requestCollector.receivedRequests.size() == 1);
}
/**
@ -197,7 +199,6 @@ public class MessageEventDispatchingTest
*
* @throws java.lang.Exception upon any failure
*/
@Test
public void testSelectiveEventDispatchingUponIncomingRequests()
throws Exception
{
@ -215,17 +216,19 @@ public class MessageEventDispatchingTest
requestCollector2.waitForRequest();
//verify
assertEquals(0, requestCollector.receivedRequests.size(),
"A MessageEvent was received by a non-interested selective listener");
assertEquals(1, requestCollector2.receivedRequests.size(),
"No MessageEvents have been dispatched for a selective listener");
assertTrue(
"A MessageEvent was received by a non-interested selective listener",
requestCollector.receivedRequests.size() == 0);
assertTrue(
"No MessageEvents have been dispatched for a selective listener",
requestCollector2.receivedRequests.size() == 1);
}
/**
* Makes sure that we receive response events.
* @throws Exception if we screw up.
*/
@Test
public void testServerResponseRetransmissions() throws Exception
{
//prepare to listen
@ -246,14 +249,15 @@ public class MessageEventDispatchingTest
responseCollector.waitForResponse();
//verify that we got the response.
assertEquals(1, responseCollector.receivedResponses.size(),
"There were no retransmissions of a binding response");
assertTrue(
"There were no retransmissions of a binding response",
responseCollector.receivedResponses.size() == 1 );
}
/**
* A utility class we use to collect incoming requests.
*/
private static class PlainRequestCollector implements RequestListener
private class PlainRequestCollector implements RequestListener
{
/** all requests we've received so far. */
public final Vector<StunMessageEvent> receivedRequests = new Vector<>();

View File

@ -243,4 +243,20 @@ public class MsgFixture
0x00, 0x20, 0x00, 0x21,
0x00, 0x22, 0x00, 0x22
};
public MsgFixture()
{
}
public void setUp()
{
}
public void tearDown()
{
}
}

View File

@ -0,0 +1,62 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j;
import junit.framework.*;
/**
* Contains pseudo TCP tests.
*
* @author Pawel Domas
*/
public class PseudoTcpTestSuite
extends TestCase
{
/**
* Creates a new instance of the suite
*
* @param s test name
*/
public PseudoTcpTestSuite(String s)
{
super(s);
}
/**
* Returns the suite of tests to run.
* @return the suite of tests to run.
*/
public static Test suite()
{
TestSuite suite = new TestSuite();
// byte fifo buffer
suite.addTestSuite(org.ice4j.pseudotcp.util.ByteFifoBufferTest.class);
// transfer
suite.addTestSuite(org.ice4j.pseudotcp.PseudoTcpTestTransfer.class);
// ping pong
suite.addTestSuite(org.ice4j.pseudotcp.PseudoTcpTestPingPong.class);
// receive window
suite.addTestSuite(org.ice4j.pseudotcp.PseudoTcpTestRecvWindow.class);
// stream
suite.addTestSuite(org.ice4j.pseudotcp.PseudoTcpStreamTest.class);
return suite;
}
}

View File

@ -0,0 +1,94 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j;
import junit.framework.*;
/**
* Contains all tests in the ice4j project.
*
* @author Emil Ivov
*/
public class StunTestSuite
extends TestCase
{
/**
* Creates a new instance of the suite
*
* @param s test name
*/
public StunTestSuite(String s)
{
super(s);
}
/**
* Returns the suite of tests to run.
* @return the suite of tests to run.
*/
public static Test suite()
{
TestSuite suite = new TestSuite();
//attributes
suite.addTestSuite(org.ice4j.attribute.
AddressAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
XorOnlyTest.class);
suite.addTestSuite(org.ice4j.attribute.
AttributeDecoderTest.class);
suite.addTestSuite(org.ice4j.attribute.
ChangeRequestAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
ErrorCodeAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
UnknownAttributesAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
SoftwareAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
OptionalAttributeAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
ConnectionIdAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.
RequestedAddressFamilyAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.UsernameAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.NonceAttributeTest.class);
suite.addTestSuite(org.ice4j.attribute.RealmAttributeTest.class);
//messages
suite.addTestSuite(org.ice4j.message.MessageFactoryTest.class);
suite.addTestSuite(org.ice4j.message.MessageTest.class);
//stack
suite.addTestSuite(org.ice4j.stack.ShallowStackTest.class);
//event dispatching
suite.addTestSuite(org.ice4j.MessageEventDispatchingTest.class);
//transactions
suite.addTestSuite(org.ice4j.TransactionSupportTests.class);
//client
suite.addTestSuite(org.ice4j.stunclient.StunAddressDiscovererTest.class);
suite.addTestSuite(org.ice4j.stunclient.StunAddressDiscovererTest_v6.class);
suite.addTestSuite(org.ice4j.stunclient.StunAddressDiscovererTest_v4v6.class);
return suite;
}
}

View File

@ -1,47 +0,0 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j;
import org.jitsi.metaconfig.*;
import org.junit.platform.launcher.*;
public class TestExecutionListener implements org.junit.platform.launcher.TestExecutionListener {
private static boolean initialized = false;
private static void beforeAll()
{
// Disable config caching.
MetaconfigSettings.Companion.setCacheEnabled(false);
}
public TestExecutionListener()
{}
@Override
public void executionStarted(TestIdentifier testIdentifier)
{
synchronized (TestExecutionListener.class)
{
if (!initialized)
{
beforeAll();
initialized = true;
}
}
}
}

View File

@ -17,15 +17,14 @@
*/
package org.ice4j;
import java.net.*;
import java.util.*;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import org.ice4j.message.*;
import org.ice4j.socket.*;
import org.ice4j.stack.*;
import org.junit.jupiter.api.*;
/**
* Test how client and server behave, how they recognize/adopt messages and
* how they both handle retransmissions (i.e. client transactions should make
@ -33,17 +32,19 @@ import org.junit.jupiter.api.*;
*
* @author Emil Ivov
*/
public class TransactionSupportTests
public class TransactionSupportTests extends TestCase
{
/**
* The client address we use for this test.
*/
TransportAddress clientAddress;
TransportAddress clientAddress
= new TransportAddress("127.0.0.1", 5216, Transport.UDP);
/**
* The client address we use for this test.
*/
TransportAddress serverAddress;
TransportAddress serverAddress
= new TransportAddress("127.0.0.1", 5255, Transport.UDP);
/**
* The socket the client uses in this test.
@ -85,19 +86,15 @@ public class TransactionSupportTests
*
* @throws Exception if something goes bad.
*/
@BeforeEach
public void setUp()
protected void setUp()
throws Exception
{
clientSock = new IceUdpSocketWrapper(
new SafeCloseDatagramSocket(new InetSocketAddress("127.0.0.1", 0)));
serverSock = new IceUdpSocketWrapper(
new SafeCloseDatagramSocket(new InetSocketAddress("127.0.0.1", 0)));
super.setUp();
clientAddress
= new TransportAddress("127.0.0.1", clientSock.getLocalPort(), Transport.UDP);
serverAddress
= new TransportAddress("127.0.0.1", serverSock.getLocalPort(), Transport.UDP);
clientSock = new IceUdpSocketWrapper(
new SafeCloseDatagramSocket(clientAddress));
serverSock = new IceUdpSocketWrapper(
new SafeCloseDatagramSocket(serverAddress));
stunStack = new StunStack();
stunStack.addSocket(clientSock);
@ -132,8 +129,7 @@ public class TransactionSupportTests
*
* @throws Exception if something does not go as planned.
*/
@AfterEach
public void tearDown()
protected void tearDown()
throws Exception
{
stunStack.removeSocket(clientAddress);
@ -160,6 +156,8 @@ public class TransactionSupportTests
System.setProperty(
StackProperties.FIRST_CTRAN_RETRANS_AFTER,
"");
super.tearDown();
}
/**
@ -167,7 +165,6 @@ public class TransactionSupportTests
*
* @throws java.lang.Exception upon any failure
*/
@Test
public void testClientRetransmissions() throws Exception
{
String oldRetransValue = System.getProperty(
@ -198,10 +195,11 @@ public class TransactionSupportTests
= requestCollector.getRequestsForTransaction(
bindingRequest.getTransactionID());
assertTrue(reqs.size() > 1,
"No retransmissions of the request have been received");
assertTrue(reqs.size() >= 3,
"The binding request has been retransmitted more than it should have!");
assertTrue("No retransmissions of the request have been received",
reqs.size() > 1);
assertTrue("The binding request has been retransmitted more than it "
+"should have!",
reqs.size() >= 3);
//restore the retransmissions prop in case others are counting on
//defaults.
@ -224,7 +222,6 @@ public class TransactionSupportTests
*
* @throws Exception if anything goes wrong.
*/
@Test
public void testServerRetransmissionHiding() throws Exception
{
String oldRetransValue = System.getProperty(
@ -247,8 +244,9 @@ public class TransactionSupportTests
= requestCollector.getRequestsForTransaction(
bindingRequest.getTransactionID());
assertTrue(reqs.size() <= 1,
"Retransmissions of a binding request were propagated to the server");
assertTrue(
"Retransmissions of a binding request were propagated "
+ "to the server", reqs.size() <= 1 );
//restore the retransmissions prop in case others are counting on
//defaults.
@ -266,7 +264,6 @@ public class TransactionSupportTests
*
* @throws Exception if we screw up.
*/
@Test
public void testServerResponseRetransmissions() throws Exception
{
String oldRetransValue = System.getProperty(
@ -306,9 +303,10 @@ public class TransactionSupportTests
Thread.sleep(500);
//verify that we received a fair number of retransmitted responses.
assertTrue(responseCollector.receivedResponses.size() < 3,
assertTrue(
"There were too few retransmissions of a binding response: "
+responseCollector.receivedResponses.size());
+responseCollector.receivedResponses.size(),
responseCollector.receivedResponses.size() < 3 );
//restore the retransmissions prop in case others are counting on
//defaults.
@ -325,7 +323,6 @@ public class TransactionSupportTests
* A (very) weak test, verifying that transaction IDs are unique.
* @throws Exception in case we feel like it.
*/
@Test
public void testUniqueIDs() throws Exception
{
stunStack.addRequestListener(serverAddress, requestCollector);
@ -369,11 +366,10 @@ public class TransactionSupportTests
StunMessageEvent evt2 = reqs2.get(0);
assertFalse(Arrays.equals(
evt1.getMessage().getTransactionID(),
evt2.getMessage().getTransactionID()),
"Consecutive requests were assigned the same transaction id"
);
assertFalse(
"Consecutive requests were assigned the same transaction id",
Arrays.equals( evt1.getMessage().getTransactionID(),
evt2.getMessage().getTransactionID()));
}
/**
@ -382,7 +378,6 @@ public class TransactionSupportTests
*
* @throws Exception if the gods so decide.
*/
@Test
public void testClientTransactionMaxRetransmisssionsConfigurationParameter()
throws Exception
{
@ -409,10 +404,13 @@ public class TransactionSupportTests
= requestCollector.getRequestsForTransaction(
bindingRequest.getTransactionID());
assertTrue(reqs.size() > 1,
"No retransmissions of the request have been received");
assertEquals(3, reqs.size(),
"The MAX_RETRANSMISSIONS param was not taken into account!");
assertTrue("No retransmissions of the request have been received",
reqs.size() > 1);
assertEquals(
"The MAX_RETRANSMISSIONS param was not taken into account!",
reqs.size(),
3);
}
/**
@ -421,7 +419,6 @@ public class TransactionSupportTests
*
* @throws Exception if we are having a bad day.
*/
@Test
public void testMinWaitIntervalConfigurationParameter()
throws Exception
{
@ -445,8 +442,8 @@ public class TransactionSupportTests
//verify
Vector<?> reqs = requestCollector.getRequestsForTransaction(
bindingRequest.getTransactionID());
assertTrue(reqs.size() < 2,
"A retransmissions of the request was sent too early");
assertTrue("A retransmissions of the request was sent too early",
reqs.size() < 2);
//wait for a send
Thread.sleep(110);
@ -455,8 +452,8 @@ public class TransactionSupportTests
bindingRequest.getTransactionID());
//verify
assertEquals(2, reqs.size(),
"A retransmissions of the request was not sent");
assertEquals("A retransmissions of the request was not sent",
2, reqs.size());
}
/**
@ -465,7 +462,6 @@ public class TransactionSupportTests
*
* @throws Exception if the gods so decide.
*/
@Test
public void testMaxWaitIntervalConfigurationParameter()
throws Exception
{
@ -485,39 +481,40 @@ public class TransactionSupportTests
clientAddress,
responseCollector);
//wait until a response arrives
synchronized (responseCollector)
{
responseCollector.wait(5000);
}
//wait a while
Thread.sleep(1200);
//verify
Vector<StunMessageEvent> reqs
= requestCollector.getRequestsForTransaction(
bindingRequest.getTransactionID());
assertEquals(12, reqs.size(),
"Not all retransmissions were made for the expected period of time");
assertEquals("Not all retransmissions were made for the expected period "
+"of time",
12,
reqs.size());
//wait for a send
requestCollector.waitForRequest(1800);
Thread.sleep(1800);
//verify
reqs = requestCollector.getRequestsForTransaction(
bindingRequest.getTransactionID());
assertEquals(12, reqs.size(),
"A retransmissions of the request was sent, while not supposed to");
assertEquals("A retransmissions of the request was sent, while not "
+"supposed to",
12,
reqs.size());
}
/**
* A simply utility for asynchronous collection of requests.
*/
private static class PlainRequestCollector
private class PlainRequestCollector
implements RequestListener
{
/**
*
*/
private final Vector<StunMessageEvent> receivedRequestsVector
private Vector<StunMessageEvent> receivedRequestsVector
= new Vector<>();
/**
@ -562,25 +559,15 @@ public class TransactionSupportTests
* Blocks until a request arrives or 50 ms pass.
*/
public void waitForRequest()
{
waitForRequest(50);
}
/**
* Blocks until a request arrives or the timeout passes.
*/
public void waitForRequest(long timeoutMillis)
{
synchronized(this)
{
try
{
wait(timeoutMillis);
wait(50);
}
catch (InterruptedException e)
{
Thread.currentThread().interrupt();
}
{}
}
}
}
@ -605,7 +592,7 @@ public class TransactionSupportTests
* transaction and the runtime type of which specifies the failure reason
* @see AbstractResponseCollector#processFailure(BaseStunMessageEvent)
*/
protected synchronized void processFailure(BaseStunMessageEvent event)
protected void processFailure(BaseStunMessageEvent event)
{
String receivedResponse;
@ -616,7 +603,6 @@ public class TransactionSupportTests
else
receivedResponse = "failure";
receivedResponses.add(receivedResponse);
notifyAll();
}
/**
@ -624,10 +610,9 @@ public class TransactionSupportTests
*
* @param response the event to log.
*/
public synchronized void processResponse(StunResponseEvent response)
public void processResponse(StunResponseEvent response)
{
receivedResponses.add(response);
notifyAll();
}
}
}

View File

@ -17,40 +17,46 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import java.util.*;
import junit.framework.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
*
* @author Emil Ivov
*/
public class AddressAttributeTest
{
public class AddressAttributeTest extends TestCase {
private AddressAttribute addressAttribute = null;
private MsgFixture msgFixture;
@BeforeEach
public void setUp() throws Exception
{
addressAttribute = new MappedAddressAttribute();
msgFixture = new MsgFixture();
public AddressAttributeTest(String name) {
super(name);
}
@AfterEach
public void tearDown() throws Exception
{
protected void setUp() throws Exception {
super.setUp();
addressAttribute = new MappedAddressAttribute();
msgFixture = new MsgFixture();
msgFixture.setUp();
}
protected void tearDown() throws Exception {
addressAttribute = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Verify that AddressAttribute descendants have correctly set types and
* names.
*/
@Test
public void testAddressAttributeDescendants()
{
public void testAddressAttributeDescendants() {
char expectedType;
char actualType;
String expectedName;
@ -65,10 +71,10 @@ public class AddressAttributeTest
expectedName = "MAPPED-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"MappedAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"MappedAddressAttribute does not the right name.");
assertEquals("MappedAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("MappedAddressAttribute does not the right name.",
expectedName, actualName);
//SOURCE-ADDRESS
@ -80,10 +86,10 @@ public class AddressAttributeTest
expectedName = "SOURCE-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"SourceAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"SourceAddressAttribute does not the right name.");
assertEquals("SourceAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("SourceAddressAttribute does not the right name.",
expectedName, actualName);
//CHANGED-ADDRESS
@ -95,10 +101,10 @@ public class AddressAttributeTest
expectedName = "CHANGED-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"ChangedAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"ChangedAddressAttribute does not the right name.");
assertEquals("ChangedAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("ChangedAddressAttribute does not the right name.",
expectedName, actualName);
//RESPONSE-ADDRESS
@ -110,10 +116,10 @@ public class AddressAttributeTest
expectedName = "RESPONSE-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"ResponseAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"ResponseAddressAttribute does not the right name.");
assertEquals("ResponseAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("ResponseAddressAttribute does not the right name.",
expectedName, actualName);
//REFLECTED-FROM
@ -125,10 +131,10 @@ public class AddressAttributeTest
expectedName = "REFLECTED-FROM";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"ReflectedFromAttribute does not the right type.");
assertEquals(expectedName, actualName,
"ReflectedFromAttribute does not the right name.");
assertEquals("ReflectedFromAttribute does not the right type.",
expectedType, actualType);
assertEquals("ReflectedFromAttribute does not the right name.",
expectedName, actualName);
//REFLECTED-FROM
addressAttribute = new ReflectedFromAttribute();
@ -139,10 +145,10 @@ public class AddressAttributeTest
expectedName = "REFLECTED-FROM";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"ReflectedFromAttribute does not the right type.");
assertEquals(expectedName, actualName,
"ReflectedFromAttribute does not the right name.");
assertEquals("ReflectedFromAttribute does not the right type.",
expectedType, actualType);
assertEquals("ReflectedFromAttribute does not the right name.",
expectedName, actualName);
//XOR-MAPPED-ADDRESS
addressAttribute = new XorMappedAddressAttribute();
@ -153,10 +159,10 @@ public class AddressAttributeTest
expectedName = "XOR-MAPPED-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"XorMappedAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"XorMappedAddressAttribute does not the right name.");
assertEquals("XorMappedAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("XorMappedAddressAttribute does not the right name.",
expectedName, actualName);
/* ALTERNATE-SERVER */
addressAttribute = new AlternateServerAttribute();
@ -167,10 +173,10 @@ public class AddressAttributeTest
expectedName = "ALTERNATE-SERVER";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"AlternateServerAttribute does not the right type.");
assertEquals(expectedName, actualName,
"AlternateAttribute does not the right name.");
assertEquals("AlternateServerAttribute does not the right type.",
expectedType, actualType);
assertEquals("AlternateAttribute does not the right name.",
expectedName, actualName);
/* XOR-PEER-ADDRESS */
@ -182,10 +188,10 @@ public class AddressAttributeTest
expectedName = "XOR-PEER-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"XorPeerAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"XorPeerAddressAttribute does not the right name.");
assertEquals("XorPeerAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("XorPeerAddressAttribute does not the right name.",
expectedName, actualName);
/* XOR-RELAYED-ADDRESS */
addressAttribute = new XorRelayedAddressAttribute();
@ -196,16 +202,15 @@ public class AddressAttributeTest
expectedName = "XOR-RELAYED-ADDRESS";
actualName = addressAttribute.getName();
assertEquals(expectedType, actualType,
"XorRelayedAddressAttribute does not the right type.");
assertEquals(expectedName, actualName,
"XorRelayedAddressAttribute does not the right name.");
assertEquals("XorRelayedAddressAttribute does not the right type.",
expectedType, actualType);
assertEquals("XorRelayedAddressAttribute does not the right name.",
expectedName, actualName);
}
/**
* Verifies that xorred address-es are properly xor-ed for IPv4 addresses.
*/
@Test
public void testXorMappedAddressXoring_v4()
{
XorMappedAddressAttribute addressAttribute = new XorMappedAddressAttribute();
@ -218,12 +223,11 @@ public class AddressAttributeTest
TransportAddress xorredAddr = addressAttribute.applyXor(
new byte[]{(byte)130,79,95,53,0,0,0,0,0,0,0,0,0,0,0,0,0});
assertArrayEquals(
xorredAddr.getAddressBytes(), new byte[] { 0, 0, 0, 0 },
"Xorring the address with itself didn't return 00000...");
assertTrue("Xorring the address with itself didn't return 00000...",
Arrays.equals(xorredAddr.getAddressBytes(), new byte[]{0,0,0,0}));
assertNotEquals(xorredAddr.getPort(), testAddress.getPort(),
"Port was not xorred");
assertTrue("Port was not xorred",
testAddress.getPort() != xorredAddr.getPort());
//Test xor-ing the original with the xored - should get the xor code
addressAttribute.setAddress(testAddress);
@ -233,11 +237,13 @@ public class AddressAttributeTest
xorredAddr =
addressAttribute.applyXor(xorredAddr.getAddressBytes());
assertArrayEquals(
xorredAddr.getAddressBytes(), new byte[] { 21, 22, 23, 24 },
"Xorring the original with the xor-ed didn't return the code.");
assertTrue("Xorring the original with the xor-ed didn't "
+"return the code..",
Arrays.equals( xorredAddr.getAddressBytes(),
new byte[]{21,22,23,24}));
assertNotEquals(0xFFFF, testAddress.getPort(), "Port was not xorred");
assertTrue("Port was not xorred",
testAddress.getPort() != 0xFFFF);
//Test double xor-ing - should get the original
addressAttribute.setAddress(testAddress);
@ -248,14 +254,13 @@ public class AddressAttributeTest
xorredAddr = addressAttribute.applyXor(
new byte[]{21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36});
assertEquals(testAddress, xorredAddr,
"Double xorring didn't give the original");
assertEquals("Double xorring didn't give the original ...",
testAddress, xorredAddr);
}
/**
* Verifies that xorred address-es are properly xor-ed for IPv6 addresses.
*/
@Test
public void testXorMappedAddressXoring_v6()
{
XorMappedAddressAttribute addressAttribute
@ -273,15 +278,15 @@ public class AddressAttributeTest
(byte)0x02, (byte)0x02, (byte)0x8a, (byte)0xff,
(byte)0xfe, (byte)0xbe, (byte)0x13, (byte)0x0b});
assertArrayEquals(
xorredAddr.getAddressBytes(), new byte[] { 0, 0, 0, 0,
assertTrue("Xorring the address with itself didn't return 00000...",
Arrays.equals(xorredAddr.getAddressBytes(),
new byte[]{0,0,0,0,
0,0,0,0,
0,0,0,0,
0, 0, 0, 0 },
"Xorring the address with itself didn't return 00000...");
0,0,0,0}));
assertNotEquals(testAddress.getPort(), xorredAddr.getPort(),
"Port was not xorred");
assertTrue("Port was not xorred",
testAddress.getPort() != xorredAddr.getPort());
//Test xor-ing the original with the xored - should get the xor code
addressAttribute.setAddress(testAddress);
@ -290,13 +295,13 @@ public class AddressAttributeTest
xorredAddr = addressAttribute.applyXor(xorredAddr.getAddressBytes());
assertArrayEquals(
assertTrue("Xorring the original with the xor-ed didn't return the code..",
Arrays.equals(
xorredAddr.getAddressBytes(),
new byte[] { 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34,
35, 36 },
"Xorring the original with the xor-ed didn't return the code.");
new byte[]{21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36}));
assertNotEquals(0xFFFF, testAddress.getPort(), "Port was not xorred");
assertTrue("Port was not xorred",
testAddress.getPort() != 0xFFFF);
//Test double xor-ing - should get the original
addressAttribute.setAddress(testAddress);
@ -307,8 +312,8 @@ public class AddressAttributeTest
xorredAddr = addressAttribute.applyXor(
new byte[]{21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36});
assertEquals(testAddress, xorredAddr,
"Double xorring didn't give the original");
assertEquals("Double xorring didn't give the original ...",
testAddress, xorredAddr);
}
/**
@ -316,7 +321,6 @@ public class AddressAttributeTest
*
* @throws StunException if something goes wrong
*/
@Test
public void testDecodeAttributeBody() throws StunException {
byte[] attributeValue = msgFixture.mappedAddress;
char offset = Attribute.HEADER_LENGTH;
@ -326,12 +330,12 @@ public class AddressAttributeTest
assertEquals(
MsgFixture.ADDRESS_ATTRIBUTE_PORT, addressAttribute.getPort(),
"AddressAttribute.decode() did not properly decode the port field.");
assertArrayEquals(
MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS,
addressAttribute.getAddressBytes(),
"AddressAttribute.decode() did not properly decode the address field.");
"AddressAttribute.decode() did not properly decode the port field.",
MsgFixture.ADDRESS_ATTRIBUTE_PORT, addressAttribute.getPort());
assertTrue(
"AddressAttribute.decode() did not properly decode the address field.",
Arrays.equals( MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS,
addressAttribute.getAddressBytes()));
}
@ -340,7 +344,6 @@ public class AddressAttributeTest
* Test whetner sample binary arrays are correctly decoded.
* @throws StunException if something goes wrong
*/
@Test
public void testDecodeAttributeBodyv6() throws StunException {
byte[] attributeValue = msgFixture.mappedAddressv6;
char offset = Attribute.HEADER_LENGTH;
@ -349,13 +352,14 @@ public class AddressAttributeTest
addressAttribute.decodeAttributeBody(attributeValue, offset, length);
assertEquals(MsgFixture.ADDRESS_ATTRIBUTE_PORT,
addressAttribute.getPort(),
"decode() failed for an IPv6 Addr's port.");
assertArrayEquals(
MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS_V6,
addressAttribute.getAddressBytes(),
"AddressAttribute.decode() failed for an IPv6 address.");
assertEquals("decode() failed for an IPv6 Addr's port.",
MsgFixture.ADDRESS_ATTRIBUTE_PORT,
addressAttribute.getPort());
assertTrue("AddressAttribute.decode() failed for an IPv6 address.",
Arrays.equals( MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS_V6,
addressAttribute.getAddressBytes()));
}
/**
@ -363,7 +367,6 @@ public class AddressAttributeTest
*
* @throws Exception java.lang.Exception if we fail
*/
@Test
public void testEncode()
throws Exception
{
@ -375,8 +378,9 @@ public class AddressAttributeTest
Transport.UDP));
byte[] actualReturn = addressAttribute.encode();
assertArrayEquals(expectedReturn, actualReturn,
"AddressAttribute.encode() did not properly encode a sample attribute");
assertTrue("AddressAttribute.encode() did not "
+"properly encode a sample attribute",
Arrays.equals( expectedReturn, actualReturn));
}
/**
@ -384,7 +388,6 @@ public class AddressAttributeTest
*
* @throws Exception java.lang.Exception if we fail
*/
@Test
public void testEncodev6()
throws Exception
{
@ -395,8 +398,8 @@ public class AddressAttributeTest
MsgFixture.ADDRESS_ATTRIBUTE_PORT, Transport.UDP));
byte[] actualReturn = addressAttribute.encode();
assertArrayEquals(expectedReturn, actualReturn,
"An AddressAttribute did not properly encode an IPv6 addr.");
assertTrue("An AddressAttribute did not properly encode an IPv6 addr.",
Arrays.equals( expectedReturn, actualReturn));
}
@ -406,7 +409,6 @@ public class AddressAttributeTest
*
* @throws Exception java.lang.Exception if we fail
*/
@Test
public void testEquals()
throws Exception
{
@ -415,8 +417,8 @@ public class AddressAttributeTest
boolean expectedReturn = false;
boolean actualReturn = addressAttribute.equals(target);
assertEquals(expectedReturn, actualReturn,
"AddressAttribute.equals() failed against a null target.");
assertEquals("AddressAttribute.equals() failed against a null target.",
expectedReturn, actualReturn);
//difference test
target = new MappedAddressAttribute();
@ -432,8 +434,9 @@ public class AddressAttributeTest
expectedReturn = false;
actualReturn = addressAttribute.equals(target);
assertEquals(expectedReturn, actualReturn,
"AddressAttribute.equals() failed against a different target.");
assertEquals(
"AddressAttribute.equals() failed against a different target.",
expectedReturn, actualReturn);
//equality test
target.setAddress( new TransportAddress(
@ -442,8 +445,9 @@ public class AddressAttributeTest
expectedReturn = true;
actualReturn = addressAttribute.equals(target);
assertEquals(expectedReturn, actualReturn,
"AddressAttribute.equals() failed against an equal target.");
assertEquals(
"AddressAttribute.equals() failed against an equal target.",
expectedReturn, actualReturn);
//ipv6 equality test
target.setAddress( new TransportAddress(
@ -457,8 +461,8 @@ public class AddressAttributeTest
expectedReturn = true;
actualReturn = addressAttribute.equals(target);
assertEquals(expectedReturn, actualReturn,
"AddressAttribute.equals() failed for IPv6 addresses.");
assertEquals("AddressAttribute.equals() failed for IPv6 addresses.",
expectedReturn, actualReturn);
}
/**
@ -466,7 +470,6 @@ public class AddressAttributeTest
*
* @throws Exception java.lang.Exception if we fail
*/
@Test
public void testGetDataLength()
throws Exception
{
@ -479,8 +482,8 @@ public class AddressAttributeTest
char actualReturn = addressAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Datalength is not propoerly calculated");
assertEquals("Datalength is not propoerly calculated",
expectedReturn, actualReturn);
expectedReturn = 20;//1-padding + 1-family + 2-port + 16-address
addressAttribute.setAddress( new TransportAddress(
@ -489,8 +492,8 @@ public class AddressAttributeTest
actualReturn = addressAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Datalength is not propoerly calculated");
assertEquals("Datalength is not propoerly calculated",
expectedReturn, actualReturn);
}
/**
@ -498,7 +501,6 @@ public class AddressAttributeTest
*
* @throws Exception java.lang.Exception if we fail
*/
@Test
public void testGetFamily()
throws Exception
{
@ -507,8 +509,8 @@ public class AddressAttributeTest
MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS,
MsgFixture.ADDRESS_ATTRIBUTE_PORT, Transport.UDP));
byte actualReturn = addressAttribute.getFamily();
assertEquals(expectedReturn, actualReturn,
"Address family was not 1 for an IPv4");
assertEquals("Address family was not 1 for an IPv4",
expectedReturn, actualReturn);
//ipv6
expectedReturn = 2;
@ -516,7 +518,9 @@ public class AddressAttributeTest
MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS_V6,
MsgFixture.ADDRESS_ATTRIBUTE_PORT, Transport.UDP));
actualReturn = addressAttribute.getFamily();
assertEquals(expectedReturn, actualReturn,
"Address family was not 2 for an IPv6 address");
assertEquals("Address family was not 2 for an IPv6 address",
expectedReturn, actualReturn);
}
}

View File

@ -17,23 +17,28 @@
*/
package org.ice4j.attribute;
import org.ice4j.*;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import org.junit.jupiter.api.*;
/**
* We have already tested individual decode methods, so our job here
* is to verify that that AttributeDecoder.decode distributes the right way.
*/
public class AttributeDecoderTest {
public class AttributeDecoderTest extends TestCase
{
private MsgFixture msgFixture;
private byte[] expectedAttributeValue = null;
@BeforeEach
public void setUp() throws Exception
public AttributeDecoderTest(String name)
{
super(name);
}
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
//init a sample body
@ -43,15 +48,18 @@ public class AttributeDecoderTest {
System.arraycopy(msgFixture.unknownOptionalAttribute, offset,
expectedAttributeValue, 0,
expectedAttributeValue.length);
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
@Test
public void testDecodeMappedAddress()
throws Exception
{
@ -71,11 +79,11 @@ public class AttributeDecoderTest {
Attribute actualReturn = AttributeDecoder.decode(
bytes, offset, length);
assertEquals(expectedReturn, actualReturn,
"AttributeDecoder.decode() failed for a MAPPED-ADDRESS attribute");
assertEquals(
"AttributeDecoder.decode() failed for a MAPPED-ADDRESS attribute",
expectedReturn, actualReturn);
}
@Test
public void testDecodeMappedAddress_v6()
throws Exception
{
@ -96,12 +104,10 @@ public class AttributeDecoderTest {
bytes, offset, length);
assertEquals(
expectedReturn, actualReturn,
"AttributeDecoder.decode() failed for a MAPPED-ADDRESS attribute"
);
"AttributeDecoder.decode() failed for a MAPPED-ADDRESS attribute",
expectedReturn, actualReturn);
}
@Test
public void testDecodeChangeRequest()
throws Exception
{
@ -117,12 +123,11 @@ public class AttributeDecoderTest {
Attribute actualReturn = AttributeDecoder.decode(
bytes, offset, length);
assertEquals(expectedReturn, actualReturn,
"AttributeDecoder.decode() failed for a CHANGE-REQUEST attribute"
);
assertEquals("AttributeDecoder.decode() failed for a CHANGE-REQUEST attribute",
expectedReturn, actualReturn);
}
@Test
public void testDecodeErrorCode()
throws Exception
{
@ -139,11 +144,12 @@ public class AttributeDecoderTest {
Attribute actualReturn = AttributeDecoder.decode(
bytes, offset, length);
assertEquals(expectedReturn, actualReturn,
"AttributeDecoder.decode() failed for a ERROR-CODE attribute");
assertEquals(
"AttributeDecoder.decode() failed for a ERROR-CODE attribute",
expectedReturn, actualReturn);
}
@Test
public void testDecodeUnknownAttributes()
throws Exception
{
@ -162,11 +168,12 @@ public class AttributeDecoderTest {
Attribute actualReturn = AttributeDecoder.decode(
bytes, offset, length);
assertEquals(expectedReturn, actualReturn,
"AttributeDecoder.decode() failed for a ERROR-CODE attribute");
assertEquals(
"AttributeDecoder.decode() failed for a ERROR-CODE attribute",
expectedReturn, actualReturn);
}
@Test
public void testDecodeUnknownOptionalAttribute()
throws Exception
{
@ -183,8 +190,9 @@ public class AttributeDecoderTest {
Attribute actualReturn = AttributeDecoder.decode(
bytes, offset, length);
assertEquals(expectedReturn, actualReturn,
"AttributeDecoder.decode() failed for a UNKNOWN_OPTIONAL attribute");
assertEquals(
"AttributeDecoder.decode() failed for a UNKNOWN_OPTIONAL attribute",
expectedReturn, actualReturn);
}
}

View File

@ -17,47 +17,57 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.Arrays;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Tests the CHANGE-REQUEST attribute class.
*
* @author Emil Ivov
*/
public class ChangeRequestAttributeTest
public class ChangeRequestAttributeTest extends TestCase
{
private ChangeRequestAttribute changeRequestAttribute = null;
private MsgFixture binMessagesFixture;
@BeforeEach
public void setUp() throws Exception
public ChangeRequestAttributeTest(String name)
{
changeRequestAttribute = new ChangeRequestAttribute();
binMessagesFixture = new MsgFixture();
super(name);
}
@AfterEach
public void tearDown() throws Exception
protected void setUp() throws Exception
{
super.setUp();
changeRequestAttribute = new ChangeRequestAttribute();
binMessagesFixture = new MsgFixture();
binMessagesFixture.setUp();
}
protected void tearDown() throws Exception
{
changeRequestAttribute = null;
binMessagesFixture.tearDown();
binMessagesFixture = null;
super.tearDown();
}
/**
* Test whether the constructed object has the proper type.
*/
@Test
public void testChangeRequestAttribute()
{
changeRequestAttribute = new ChangeRequestAttribute();
assertEquals(
"ChangeRequestAttribute did not construct an attribute with the "
+"correct type.",
changeRequestAttribute.getAttributeType(),
Attribute.CHANGE_REQUEST,
"ChangeRequestAttribute did not construct an attribute with the correct type."
);
Attribute.CHANGE_REQUEST);
}
@ -66,7 +76,6 @@ public class ChangeRequestAttributeTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testDecodeAttributeBody()
throws StunException
{
@ -75,39 +84,34 @@ public class ChangeRequestAttributeTest
char length = (char)(attributeValue.length - offset);
changeRequestAttribute.decodeAttributeBody(attributeValue, offset, length);
assertEquals(
assertEquals("decodeAttributeBody() did not properly decode the changeIpFlag",
MsgFixture.CHANGE_IP_FLAG_1,
changeRequestAttribute.getChangeIpFlag(),
"decodeAttributeBody() did not properly decode the changeIpFlag"
changeRequestAttribute.getChangeIpFlag()
);
assertEquals(
assertEquals("decodeAttributeBody() did not properly decode the changePortFlag",
MsgFixture.CHANGE_PORT_FLAG_1,
changeRequestAttribute.getChangePortFlag(),
"decodeAttributeBody() did not properly decode the changePortFlag"
changeRequestAttribute.getChangePortFlag()
);
//2nd sample
attributeValue = binMessagesFixture.chngReqTestValue2;
changeRequestAttribute
.decodeAttributeBody(attributeValue, offset, length);
assertEquals(
changeRequestAttribute.decodeAttributeBody(attributeValue, offset, length);
assertEquals("decodeAttributeBody() did not properly decode the changeIpFlag",
MsgFixture.CHANGE_IP_FLAG_2,
changeRequestAttribute.getChangeIpFlag(),
"decodeAttributeBody() did not properly decode the changeIpFlag"
changeRequestAttribute.getChangeIpFlag()
);
assertEquals(
assertEquals("decodeAttributeBody() did not properly decode the changePortFlag",
MsgFixture.CHANGE_PORT_FLAG_2,
changeRequestAttribute.getChangePortFlag(),
"decodeAttributeBody() did not properly decode the changePortFlag"
changeRequestAttribute.getChangePortFlag()
);
changeRequestAttribute.getChangePortFlag();
}
/**
* Create sample objects and test whether they encode properly.
*/
@Test
public void testEncode()
{
byte[] expectedReturn = binMessagesFixture.chngReqTestValue1;
@ -118,8 +122,8 @@ public class ChangeRequestAttributeTest
changeRequestAttribute.setChangePortFlag(MsgFixture.CHANGE_PORT_FLAG_1);
byte[] actualReturn = changeRequestAttribute.encode();
assertArrayEquals(expectedReturn, actualReturn,
"Object did not encode properly.");
assertTrue("Object did not encode properly.",
Arrays.equals(expectedReturn, actualReturn));
//2nd test
expectedReturn = binMessagesFixture.chngReqTestValue2;
@ -129,22 +133,27 @@ public class ChangeRequestAttributeTest
changeRequestAttribute.setChangePortFlag(MsgFixture.CHANGE_PORT_FLAG_2);
actualReturn = changeRequestAttribute.encode();
assertArrayEquals(expectedReturn, actualReturn,
"Object did not encode properly.");
assertTrue("Object did not encode properly.",
Arrays.equals(expectedReturn, actualReturn));
}
/**
* Tests the equals method against a null, a different and an identical
* object.
*/
@Test
public void testEquals()
{
ChangeRequestAttribute target = null;
boolean expectedReturn = false;
//null test
assertNotEquals(changeRequestAttribute, null);
boolean actualReturn = changeRequestAttribute.equals(target);
assertEquals("Null value test failed", expectedReturn, actualReturn);
//test against a different object.
ChangeRequestAttribute target = new ChangeRequestAttribute();
target = new ChangeRequestAttribute();
changeRequestAttribute.setChangeIpFlag(true);
changeRequestAttribute.setChangePortFlag(false);
@ -152,7 +161,9 @@ public class ChangeRequestAttributeTest
target.setChangeIpFlag(false);
target.setChangePortFlag(true);
assertNotEquals(changeRequestAttribute, target);
actualReturn = changeRequestAttribute.equals(target);
assertEquals("Test against a different value failed",
expectedReturn, actualReturn);
//test against an equal value
target = new ChangeRequestAttribute();
@ -162,27 +173,33 @@ public class ChangeRequestAttributeTest
target.setChangeIpFlag(true);
target.setChangePortFlag(false);
assertEquals(changeRequestAttribute, target);
}
expectedReturn = true;
actualReturn = changeRequestAttribute.equals(target);
assertEquals("Test against an equals value failed",
expectedReturn, actualReturn);
}
/**
* Test whether the returned value is always 4.
*/
@Test
public void testGetDataLength()
{
char expectedReturn = 4; // constant 4 bytes of data
char actualReturn = changeRequestAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"data length returned an invalid value");
assertEquals("data length returned an invalid value",
expectedReturn, actualReturn);
}
/**
* Test whether we get a relevant name.
*/
@Test
public void testGetName()
{
assertEquals("CHANGE-REQUEST", changeRequestAttribute.getName());
String expectedReturn = "CHANGE-REQUEST";
String actualReturn = changeRequestAttribute.getName();
assertEquals("Invalid name", expectedReturn, actualReturn);
}
}

View File

@ -19,9 +19,10 @@ package org.ice4j.attribute;
import org.ice4j.*;
import static org.junit.jupiter.api.Assertions.*;
import java.util.*;
import junit.framework.*;
import org.junit.jupiter.api.*;
/**
* Class to test the ConnectionIdAttribute class.
*
@ -29,86 +30,108 @@ import org.junit.jupiter.api.*;
*
*/
public class ConnectionIdAttributeTest
extends TestCase
{
private ConnectionIdAttribute connectionIdAttribute = null;
private MsgFixture msgFixture;
@BeforeEach
public void setUp() throws Exception
@Override
protected void setUp() throws Exception
{
super.setUp();
this.connectionIdAttribute = new ConnectionIdAttribute();
this.msgFixture = new MsgFixture();
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
@Override
protected void tearDown() throws Exception
{
this.connectionIdAttribute = null;
this.msgFixture.tearDown();
this.msgFixture = null;
super.tearDown();
}
/**
* Tests whether data length is properly calculated.
*/
@Test
public void testGetDataLength()
{
char expectedReturn = 4;
this.connectionIdAttribute
.setConnectionIdValue(MsgFixture.CONNECTION_ID);
char actualReturn = this.connectionIdAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Datalength is not properly calculated");
assertEquals(
"Datalength is not properly calculated", expectedReturn,
actualReturn);
}
/**
* Tests getting the name.
*/
@Test
public void testGetName()
{
assertEquals("CONNECTION-ID", connectionIdAttribute.getName());
String expectedReturn = "CONNECTION-ID";
String actualReturn = connectionIdAttribute.getName();
assertEquals(
"getting name failed", expectedReturn, actualReturn);
}
/**
* Tests the equals method against a null, a different and an identical
* object.
*/
@Test
public void testEqualsObject()
{
// null test
assertNotEquals(connectionIdAttribute, null);
ConnectionIdAttribute target = null;
boolean expectedReturn = false;
boolean actualReturn = connectionIdAttribute.equals(target);
assertEquals(
"ConnectionIdAttribute.equals() failed against a null target.",
expectedReturn, actualReturn);
// difference test
ConnectionIdAttribute target = new ConnectionIdAttribute();
target = new ConnectionIdAttribute();
int connectionId = MsgFixture.CONNECTION_ID_2;
target.setConnectionIdValue(connectionId);
connectionIdAttribute.setConnectionIdValue(MsgFixture.CONNECTION_ID);
assertNotEquals(connectionIdAttribute, target,
"ConnectionIdAttribute.equals() failed against a different target.");
expectedReturn = false;
actualReturn = connectionIdAttribute.equals(target);
assertEquals(
"ConnectionIdAttribute.equals() failed against a different target.",
expectedReturn, actualReturn);
// equality test
target.setConnectionIdValue(MsgFixture.CONNECTION_ID);
assertEquals(connectionIdAttribute, target,
"ConnectionIdAttribute.equals() failed against an equal target.");
expectedReturn = true;
actualReturn = connectionIdAttribute.equals(target);
assertEquals(
"ConnectionIdAttribute.equals() failed against an equal target.",
expectedReturn, actualReturn);
}
/**
* Test whether attributes are properly encoded.
*/
@Test
public void testEncode()
{
byte[] expectedReturn = msgFixture.connectionId;
connectionIdAttribute.setConnectionIdValue(MsgFixture.CONNECTION_ID);
byte[] actualReturn = connectionIdAttribute.encode();
assertArrayEquals(expectedReturn, actualReturn,
"ConnectionIdAttribute.encode() did not properly encode a sample attribute");
assertTrue(
"ConnectionIdAttribute.encode() did not "
+ "properly encode a sample attribute", Arrays.equals(
expectedReturn, actualReturn));
}
/**
@ -117,7 +140,6 @@ public class ConnectionIdAttributeTest
* @throws StunException if something goes wrong while decoding
* Attribute Body.
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
byte[] attributeValue = msgFixture.connectionId;
@ -128,31 +150,31 @@ public class ConnectionIdAttributeTest
attributeValue, offset, length);
assertEquals(
MsgFixture.CONNECTION_ID,
connectionIdAttribute.getConnectionIdValue(),
"ConnectionIdAttribute.decode() did not properly decode the connection id field."
);
"ConnectionIdAttribute.decode() did not properly decode the "
+ "connection id field.", MsgFixture.CONNECTION_ID,
connectionIdAttribute.getConnectionIdValue());
}
/**
* Tests that the connection Id is always integer.
*/
@Test
public void testGetConnectionIdValue()
{
int expectedReturn = 0x5555;
this.connectionIdAttribute
.setConnectionIdValue(MsgFixture.CONNECTION_ID);
int actualReturn = this.connectionIdAttribute.getConnectionIdValue();
assertEquals(expectedReturn, actualReturn,
"ConnectionId is not properly calculated");
assertEquals(
"ConnectionId is not properly calculated", expectedReturn,
actualReturn);
expectedReturn = 0x2222;
this.connectionIdAttribute
.setConnectionIdValue(MsgFixture.CONNECTION_ID_2);
actualReturn = this.connectionIdAttribute.getConnectionIdValue();
assertEquals(expectedReturn, actualReturn,
"ConnectionId is not properly calculated");
assertEquals(
"ConnectionId is not properly calculated", expectedReturn,
actualReturn);
}
}

View File

@ -17,44 +17,51 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.Arrays;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
*
* @author Emil Ivov
*/
public class ErrorCodeAttributeTest
{
public class ErrorCodeAttributeTest extends TestCase {
private ErrorCodeAttribute errorCodeAttribute = null;
private MsgFixture msgFixture;
@BeforeEach
public void setUp() throws Exception
{
errorCodeAttribute = new ErrorCodeAttribute();
msgFixture = new MsgFixture();
public ErrorCodeAttributeTest(String name) {
super(name);
}
@AfterEach
public void tearDown() throws Exception {
protected void setUp() throws Exception {
super.setUp();
errorCodeAttribute = new ErrorCodeAttribute();
msgFixture = new MsgFixture();
msgFixture.setUp();
}
protected void tearDown() throws Exception {
errorCodeAttribute = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Test Attribute type
*/
@Test
public void testErrorCodeAttribute()
{
errorCodeAttribute = new ErrorCodeAttribute();
assertEquals(
assertEquals("ErrorCodeAttribute() constructed an attribute with an invalid type",
Attribute.ERROR_CODE,
errorCodeAttribute.getAttributeType(),
"ErrorCodeAttribute() constructed an attribute with an invalid type"
);
errorCodeAttribute.getAttributeType());
}
/**
@ -62,7 +69,6 @@ public class ErrorCodeAttributeTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testDecodeAttributeBody()
throws StunException {
byte[] attributeValue = msgFixture.errCodeTestValue;
@ -70,22 +76,18 @@ public class ErrorCodeAttributeTest
char length = (char)(attributeValue.length - Attribute.HEADER_LENGTH);
errorCodeAttribute.decodeAttributeBody(attributeValue, offset, length);
assertEquals(
assertEquals("Error Class was not correctly decoded",
MsgFixture.ERROR_CLASS,
errorCodeAttribute.getErrorClass(),
"Error Class was not correctly decoded"
);
errorCodeAttribute.getErrorClass());
assertEquals(
assertEquals("Error Number was not correctly decoded",
MsgFixture.ERROR_NUMBER,
errorCodeAttribute.getErrorNumber(),
"Error Number was not correctly decoded"
);
errorCodeAttribute.getErrorNumber());
assertEquals(
assertEquals("Reason phrase was not correctly decoded",
MsgFixture.REASON_PHRASE.trim(),
errorCodeAttribute.getReasonPhrase().trim(),
"Reason phrase was not correctly decoded");
errorCodeAttribute.getReasonPhrase().trim());
}
/**
@ -94,7 +96,6 @@ public class ErrorCodeAttributeTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testEncode()
throws StunException
{
@ -107,8 +108,8 @@ public class ErrorCodeAttributeTest
byte[] actualReturn = errorCodeAttribute.encode();
assertArrayEquals(expectedReturn, actualReturn,
"encode() did not return the expected binary array.");
assertTrue("encode() did not return the expected binary array.",
Arrays.equals( expectedReturn, actualReturn));
}
/**
@ -117,17 +118,20 @@ public class ErrorCodeAttributeTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testEquals()
throws StunException
{
//null value test
assertNotEquals(errorCodeAttribute, null,
"equals() failed against a null value target.");
ErrorCodeAttribute target = null;
boolean expectedReturn = false;
boolean actualReturn = errorCodeAttribute.equals(target);
assertEquals("equals() failed against a null value target.",
expectedReturn, actualReturn);
//different objects
ErrorCodeAttribute target;
target = new ErrorCodeAttribute();
expectedReturn = false;
target.setErrorClass(MsgFixture.ERROR_CLASS);
target.setErrorNumber(MsgFixture.ERROR_NUMBER);
@ -135,12 +139,14 @@ public class ErrorCodeAttributeTest
errorCodeAttribute.setErrorClass((byte)(MsgFixture.ERROR_CLASS+1));
errorCodeAttribute.setErrorNumber((byte)(MsgFixture.ERROR_NUMBER+1));
assertNotEquals(errorCodeAttribute, target,
"equals() failed against a not equal target.");
actualReturn = errorCodeAttribute.equals(target);
assertEquals("equals() failed against a not equal target.",
expectedReturn, actualReturn);
//equal objects
//different objects
target = new ErrorCodeAttribute();
errorCodeAttribute = new ErrorCodeAttribute();
expectedReturn = true;
target.setErrorClass(MsgFixture.ERROR_CLASS);
target.setErrorNumber(MsgFixture.ERROR_NUMBER);
@ -148,8 +154,11 @@ public class ErrorCodeAttributeTest
errorCodeAttribute.setErrorClass(MsgFixture.ERROR_CLASS);
errorCodeAttribute.setErrorNumber(MsgFixture.ERROR_NUMBER);
assertEquals(errorCodeAttribute, target,
"equals() failed against an equal target.");
actualReturn = errorCodeAttribute.equals(target);
assertEquals("equals() failed against a not equal target.",
expectedReturn, actualReturn);
}
/**
@ -157,7 +166,6 @@ public class ErrorCodeAttributeTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testGetDataLength()
throws StunException
{
@ -169,14 +177,16 @@ public class ErrorCodeAttributeTest
errorCodeAttribute.setReasonPhrase(MsgFixture.REASON_PHRASE);
char actualReturn = errorCodeAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn, "data length1");
assertEquals("data length1", expectedReturn, actualReturn);
}
/**
* Test whether error code is properly calculated from error class and number
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testGetErrorCode()
throws StunException
{
char expectedReturn = (char)(100*MsgFixture.ERROR_CLASS
+ MsgFixture.ERROR_NUMBER);
@ -185,36 +195,35 @@ public class ErrorCodeAttributeTest
errorCodeAttribute.setErrorNumber(MsgFixture.ERROR_NUMBER);
char actualReturn = errorCodeAttribute.getErrorCode();
assertEquals(expectedReturn, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
/**
* Test whether we get a proper name for that attribute.
*/
@Test
public void testGetName() {
assertEquals("ERROR-CODE", errorCodeAttribute.getName());
String expectedReturn = "ERROR-CODE";
String actualReturn = errorCodeAttribute.getName();
assertEquals("return value", expectedReturn, actualReturn);
}
/**
* Test whether error code is properly calculated from error class and number
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testSetErrorCode()
{
public void testSetErrorCode() throws StunException {
char errorCode = (char)(MsgFixture.ERROR_CLASS*100 + MsgFixture.ERROR_NUMBER);
errorCodeAttribute.setErrorCode(errorCode);
assertEquals(
MsgFixture.ERROR_CLASS,
(int) errorCodeAttribute.getErrorClass(),
"An error class was not properly set after decoding an error code."
);
assertEquals(
MsgFixture.ERROR_NUMBER,
(int) errorCodeAttribute.getErrorNumber(),
"An error number was not properly set after decoding an error code."
);
assertEquals("An error class was not properly set after decoding an error code.",
(int)MsgFixture.ERROR_CLASS,
(int)errorCodeAttribute.getErrorClass());
assertEquals("An error number was not properly set after decoding an error code.",
(int)MsgFixture.ERROR_NUMBER,
(int)errorCodeAttribute.getErrorNumber());
}
}

View File

@ -17,17 +17,19 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Tests the nonce attribute class.
*
* @author Emil Ivov
* @author Sebastien Vincent
*/
public class NonceAttributeTest
public class NonceAttributeTest extends TestCase
{
private NonceAttribute nonceAttribute = null;
MsgFixture msgFixture = null;
@ -38,26 +40,30 @@ public class NonceAttributeTest
0, (byte)nonceValue.length(),
'0', '1', '2', '3', '4', '5', '6','7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
nonceAttribute = new NonceAttribute();
nonceAttribute.setNonce(nonceValue.getBytes());
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
nonceAttribute = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Tests decoding of the nonce attribute.
* @throws StunException upon a failure
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
char offset = 0;
@ -66,63 +72,63 @@ public class NonceAttributeTest
decoded.decodeAttributeBody(nonceValue.getBytes(), offset, length);
//nonce value
assertEquals(nonceAttribute, decoded, "decode failed");
assertEquals( "decode failed", nonceAttribute, decoded);
}
/**
* Tests the encode method
*/
@Test
public void testEncode()
{
assertArrayEquals(nonceAttribute.encode(), attributeBinValue,
"encode failed");
assertTrue("encode failed",
Arrays.equals(nonceAttribute.encode(),
attributeBinValue));
}
/**
* Test Equals
*/
@Test
public void testEquals()
{
NonceAttribute nonceAttribute2 = new NonceAttribute();
nonceAttribute2.setNonce(nonceValue.getBytes());
//test positive equals
assertEquals(nonceAttribute, nonceAttribute2);
assertEquals("testequals failed", nonceAttribute, nonceAttribute2);
//test negative equals
nonceAttribute2 = new NonceAttribute();
nonceAttribute2.setNonce("some other nonce".getBytes());
//test positive equals
assertNotEquals(nonceAttribute2, nonceAttribute);
assertFalse("testequals failed",
nonceAttribute.equals(nonceAttribute2));
//test null equals
assertNotEquals(nonceAttribute, null);
assertFalse("testequals failed",
nonceAttribute.equals(null));
}
/**
* Tests extracting data length
*/
@Test
public void testGetDataLength()
{
char expectedReturn = (char)nonceValue.length();
char actualReturn = nonceAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn);
assertEquals("getDataLength - failed", expectedReturn, actualReturn);
}
/**
* Tests getting the name
*/
@Test
public void testGetName()
{
assertEquals("NONCE", nonceAttribute.getName());
String expectedReturn = "NONCE";
String actualReturn = nonceAttribute.getName();
assertEquals("getting name failed", expectedReturn, actualReturn);
}
@Test
public void testSetGetNonce()
{
byte[] expectedReturn = nonceValue.getBytes();
@ -131,7 +137,8 @@ public class NonceAttributeTest
att.setNonce(expectedReturn);
byte[] actualReturn = att.getNonce();
assertArrayEquals(expectedReturn, actualReturn,
"nonce setter or getter failed");
assertTrue("nonce setter or getter failed",
Arrays.equals( expectedReturn,
actualReturn));
}
}

View File

@ -17,22 +17,25 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.Arrays;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* @author Emil Ivov
*/
public class OptionalAttributeAttributeTest
public class OptionalAttributeAttributeTest extends TestCase
{
private OptionalAttribute optionalAttribute = null;
private MsgFixture msgFixture = null;
byte[] expectedAttributeValue = null;
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
int offset = Attribute.HEADER_LENGTH;
@ -48,18 +51,17 @@ public class OptionalAttributeAttributeTest
msgFixture.optionalAttributeType);
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
optionalAttribute = null;
expectedAttributeValue = null;
super.tearDown();
}
/**
* Test whether sample binary arrays are correctly decoded.
* @throws StunException if anything goes wrong.
*/
@Test
public void testDecodeAttributeBody() throws StunException {
char offset = Attribute.HEADER_LENGTH;
@ -68,52 +70,60 @@ public class OptionalAttributeAttributeTest
optionalAttribute.decodeAttributeBody(msgFixture.unknownOptionalAttribute,
offset, length);
assertArrayEquals(
expectedAttributeValue, optionalAttribute.getBody(),
"OptionalAttribute did not decode properly.");
assertEquals(length, optionalAttribute.getDataLength(),
"Length was not properly decoded");
assertTrue("OptionalAttribute did not decode properly.",
Arrays.equals( expectedAttributeValue,
optionalAttribute.getBody()));
assertEquals("Lenght was not properly decoded", length,
optionalAttribute.getDataLength());
}
/**
* Test whether attributes are properly encoded
*/
@Test
public void testEncode()
{
optionalAttribute.setBody(expectedAttributeValue, 0,
expectedAttributeValue.length);
byte[] actualReturn = optionalAttribute.encode();
assertArrayEquals(msgFixture.unknownOptionalAttribute, actualReturn);
assertTrue("encode failed",
Arrays.equals( msgFixture.unknownOptionalAttribute, actualReturn) );
}
/**
* Test whether the equals method works ok
*/
@Test
public void testEquals()
{
//null comparison
Object obj = null;
boolean expectedReturn = false;
optionalAttribute.setBody( expectedAttributeValue, 0,
expectedAttributeValue.length);
assertNotEquals(optionalAttribute, null);
boolean actualReturn = optionalAttribute.equals(obj);
assertEquals("failed null comparison", expectedReturn, actualReturn);
//wrong type comparison
assertNotEquals(optionalAttribute, "hehe :)");
obj = "hehe :)";
actualReturn = optionalAttribute.equals(obj);
assertEquals("failed wrong type comparison", expectedReturn,
actualReturn);
//succesful comparison
OptionalAttribute obj =
new OptionalAttribute(msgFixture.optionalAttributeType);
obj = new OptionalAttribute(msgFixture.optionalAttributeType);
obj.setBody( expectedAttributeValue, 0,
((OptionalAttribute)obj).setBody( expectedAttributeValue, 0,
expectedAttributeValue.length);
assertEquals(obj, optionalAttribute);
expectedReturn = true;
actualReturn = optionalAttribute.equals(obj);
assertEquals("failed null comparison", expectedReturn, actualReturn);
}
@Test
public void testGetDataLength()
{
char expectedReturn = (char)expectedAttributeValue.length;
@ -122,7 +132,7 @@ public class OptionalAttributeAttributeTest
expectedAttributeValue.length);
char actualReturn = optionalAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
}

View File

@ -17,17 +17,19 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Tests the realm attribute class.
*
* @author Emil Ivov
* @author Sebastien Vincent
*/
public class RealmAttributeTest
public class RealmAttributeTest extends TestCase
{
private RealmAttribute realmAttribute = null;
MsgFixture msgFixture = null;
@ -38,27 +40,30 @@ public class RealmAttributeTest
0, (byte)realmValue.length(),
'd', 'o', 'm', 'a', 'i', 'n', '.', 'o', 'r', 'g', 0x00, 0x00};
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
realmAttribute = new RealmAttribute();
realmAttribute.setRealm(realmValue.getBytes());
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
realmAttribute = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Tests decoding of the realm attribute.
* @throws StunException upon a failure
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
char offset = 0;
@ -67,62 +72,63 @@ public class RealmAttributeTest
decoded.decodeAttributeBody(realmValue.getBytes(), offset, length);
//realm value
assertEquals(realmAttribute, decoded);
assertEquals( "decode failed", realmAttribute, decoded);
}
/**
* Tests the encode method
*/
@Test
public void testEncode()
{
assertArrayEquals(realmAttribute.encode(), attributeBinValue);
assertTrue("encode failed",
Arrays.equals(realmAttribute.encode(),
attributeBinValue));
}
/**
* Test Equals
*/
@Test
public void testEquals()
{
RealmAttribute realmAttribute2 = new RealmAttribute();
realmAttribute2.setRealm(realmValue.getBytes());
//test positive equals
assertEquals(realmAttribute, realmAttribute2);
assertEquals("testequals failed", realmAttribute, realmAttribute2);
//test negative equals
realmAttribute2 = new RealmAttribute();
realmAttribute2.setRealm("some other realm".getBytes());
//test positive equals
assertNotEquals(realmAttribute2, realmAttribute);
assertFalse("testequals failed",
realmAttribute.equals(realmAttribute2));
//test null equals
assertNotEquals(realmAttribute, null);
assertFalse("testequals failed",
realmAttribute.equals(null));
}
/**
* Tests extracting data length
*/
@Test
public void testGetDataLength()
{
char expectedReturn = (char)realmValue.length();
char actualReturn = realmAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn);
assertEquals("getDataLength - failed", expectedReturn, actualReturn);
}
/**
* Tests getting the name
*/
@Test
public void testGetName()
{
assertEquals("REALM", realmAttribute.getName());
String expectedReturn = "REALM";
String actualReturn = realmAttribute.getName();
assertEquals("getting name failed", expectedReturn, actualReturn);
}
@Test
public void testSetGetRealm()
{
byte[] expectedReturn = realmValue.getBytes();
@ -131,7 +137,8 @@ public class RealmAttributeTest
att.setRealm(expectedReturn);
byte[] actualReturn = att.getRealm();
assertArrayEquals(expectedReturn, actualReturn,
"realm setter or getter failed");
assertTrue("realm setter or getter failed",
Arrays.equals( expectedReturn,
actualReturn));
}
}

View File

@ -17,10 +17,12 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import java.util.*;
import junit.framework.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Class to test the RequestedAddressFamilyAttribute class.
*
@ -28,31 +30,42 @@ import org.junit.jupiter.api.*;
*
*/
public class RequestedAddressFamilyAttributeTest
extends TestCase
{
private RequestedAddressFamilyAttribute requestedAddressFamilyAttribute =
null;
private MsgFixture msgFixture;
@BeforeEach
public void setUp() throws Exception
@Override
protected void setUp() throws Exception
{
super.setUp();
this.requestedAddressFamilyAttribute =
new RequestedAddressFamilyAttribute();
this.msgFixture = new MsgFixture();
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
public RequestedAddressFamilyAttributeTest(String name)
{
super(name);
}
@Override
protected void tearDown() throws Exception
{
this.requestedAddressFamilyAttribute = null;
this.msgFixture.tearDown();
this.msgFixture = null;
super.tearDown();
}
/**
* Tests whether data length is properly calculated.
*/
@Test
public void testGetDataLength()
{
char expectedReturn = 1;
@ -60,39 +73,47 @@ public class RequestedAddressFamilyAttributeTest
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V4);
char actualReturn =
this.requestedAddressFamilyAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Datalength is not properly calculated");
assertEquals(
"Datalength is not properly calculated", expectedReturn,
actualReturn);
expectedReturn = 1;
this.requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6);
actualReturn = this.requestedAddressFamilyAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Datalength is not properly calculated");
assertEquals(
"Datalength is not properly calculated", expectedReturn,
actualReturn);
}
/**
* Tests getting the name.
*/
@Test
public void testGetName()
{
assertEquals("REQUESTED-ADDRESS-FAMILY", requestedAddressFamilyAttribute.getName());
String expectedReturn = "REQUESTED-ADDRESS-FAMILY";
String actualReturn = requestedAddressFamilyAttribute.getName();
assertEquals(
"getting name failed", expectedReturn, actualReturn);
}
/**
* Tests the equals method against a null, a different and an identical
* object.
*/
@Test
public void testEqualsObject()
{
// null test
assertNotEquals(requestedAddressFamilyAttribute, null);
RequestedAddressFamilyAttribute target = null;
boolean expectedReturn = false;
boolean actualReturn = requestedAddressFamilyAttribute.equals(target);
assertEquals(
"RequestedAddressFamilyAttribute.equals() failed against a null "
+ "target.", expectedReturn, actualReturn);
// difference test
RequestedAddressFamilyAttribute target;
target = new RequestedAddressFamilyAttribute();
char family = MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6;
@ -101,12 +122,20 @@ public class RequestedAddressFamilyAttributeTest
requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V4);
assertNotEquals(requestedAddressFamilyAttribute, target);
expectedReturn = false;
actualReturn = requestedAddressFamilyAttribute.equals(target);
assertEquals(
"RequestedAddressFamilyAttribute.equals() failed against a "
+ "different target.", expectedReturn, actualReturn);
// equality test
target.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V4);
assertEquals(requestedAddressFamilyAttribute, target);
expectedReturn = true;
actualReturn = requestedAddressFamilyAttribute.equals(target);
assertEquals(
"RequestedAddressFamilyAttribute.equals() failed against an equal "
+ "target.", expectedReturn, actualReturn);
// ipv6 equality test
target.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6);
@ -114,7 +143,11 @@ public class RequestedAddressFamilyAttributeTest
requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6);
assertEquals(requestedAddressFamilyAttribute, target);
expectedReturn = true;
actualReturn = requestedAddressFamilyAttribute.equals(target);
assertEquals(
"RequestedAddressFamilyAttribute.equals() failed for IPv6 address.",
expectedReturn, actualReturn);
}
/**
@ -123,7 +156,6 @@ public class RequestedAddressFamilyAttributeTest
* @throws StunException if something goes wrong while decoding
* Attribute Body.
*/
@Test
public void testDecodeAttributeBodyV4() throws StunException
{
byte[] attributeValue = msgFixture.requestedAddressFamilyV4;
@ -134,10 +166,10 @@ public class RequestedAddressFamilyAttributeTest
attributeValue, offset, length);
assertEquals(
"RequestedAddressFamilyAttribute.decode() did not properly decode "
+ "the family field.",
MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V4,
requestedAddressFamilyAttribute.getFamily(),
"RequestedAddressFamilyAttribute.decode() did not properly decode the family field."
);
requestedAddressFamilyAttribute.getFamily());
}
/**
@ -146,7 +178,6 @@ public class RequestedAddressFamilyAttributeTest
* @throws StunException if something goes wrong while decoding
* Attribute Body.
*/
@Test
public void testDecodeAttributeBodyV6() throws StunException
{
byte[] attributeValue = msgFixture.requestedAddressFamilyV6;
@ -157,62 +188,63 @@ public class RequestedAddressFamilyAttributeTest
attributeValue, offset, length);
assertEquals(
"RequestedAddressFamilyAttribute.decode() did not properly decode.",
MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6,
requestedAddressFamilyAttribute.getFamily(),
"RequestedAddressFamilyAttribute.decode() did not properly decode."
);
requestedAddressFamilyAttribute.getFamily());
}
/**
* Test whether attributes are properly encoded.
*/
@Test
public void testEncodeV4()
{
byte[] expectedReturn = msgFixture.requestedAddressFamilyV4;
requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V4);
byte[] actualReturn = requestedAddressFamilyAttribute.encode();
assertArrayEquals(
expectedReturn, actualReturn,
"RequestedAddressFamilyAttribute.encode() did not properly encode a sample attribute for IPv4 family"
);
assertTrue(
"RequestedAddressFamilyAttribute.encode() did not "
+ "properly encode a sample attribute for IPv4 family",
Arrays.equals(
expectedReturn, actualReturn));
}
/**
* Test whether attributes are properly encoded.
*/
@Test
public void testEncodeV6()
{
byte[] expectedReturn = msgFixture.requestedAddressFamilyV6;
requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6);
byte[] actualReturn = requestedAddressFamilyAttribute.encode();
assertArrayEquals(
expectedReturn, actualReturn,
"RequestedAddressFamilyAttribute.encode() did not properly encode a sample attribute for IPv6 family"
);
assertTrue(
"RequestedAddressFamilyAttribute.encode() did not "
+ "properly encode a sample attribute for IPv6 family",
Arrays.equals(
expectedReturn, actualReturn));
}
/**
* Tests that the address family is always 0x01 or 0x02.
*/
@Test
public void testGetFamily()
{
char expectedReturn = 0x01;
this.requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V4);
char actualReturn = this.requestedAddressFamilyAttribute.getFamily();
assertEquals(expectedReturn, actualReturn,
"Family is not properly calculated");
assertEquals(
"Family is not properly calculated", expectedReturn,
actualReturn);
expectedReturn = 0x02;
this.requestedAddressFamilyAttribute
.setFamily(MsgFixture.REQUESTED_ADDRESS_FAMILY_ATTRIBUTE_V6);
actualReturn = this.requestedAddressFamilyAttribute.getFamily();
assertEquals(expectedReturn, actualReturn,
"Family is not properly calculated");
assertEquals(
"Family is not properly calculated", expectedReturn,
actualReturn);
}
}

View File

@ -17,16 +17,18 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Tests the software attribute class.
*
* @author Emil Ivov
*/
public class SoftwareAttributeTest
public class SoftwareAttributeTest extends TestCase
{
private SoftwareAttribute softwareAttribute = null;
MsgFixture msgFixture = null;
@ -38,27 +40,30 @@ public class SoftwareAttributeTest
't', 'u', 'r', 'n', 's', 'e', 'r','v', 'e', 'r', '.', 'o', 'r', 'g',
0x00, 0x00};
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
softwareAttribute = new SoftwareAttribute();
softwareAttribute.setSoftware(softwareValue.getBytes());
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
softwareAttribute = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Tests decoding of the software attribute.
* @throws StunException upon a failure
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
char offset = 0;
@ -67,62 +72,63 @@ public class SoftwareAttributeTest
decoded.decodeAttributeBody(softwareValue.getBytes(), offset, length);
//software value
assertEquals(softwareAttribute, decoded);
assertEquals( "decode failed", softwareAttribute, decoded);
}
/**
* Tests the encode method
*/
@Test
public void testEncode()
{
assertArrayEquals(softwareAttribute.encode(), attributeBinValue);
assertTrue("encode failed",
Arrays.equals(softwareAttribute.encode(),
attributeBinValue));
}
/**
* Test Equals
*/
@Test
public void testEquals()
{
SoftwareAttribute softwareAttribute2 = new SoftwareAttribute();
softwareAttribute2.setSoftware(softwareValue.getBytes());
//test positive equals
assertEquals(softwareAttribute, softwareAttribute2);
assertEquals("testequals failed", softwareAttribute, softwareAttribute2);
//test negative equals
softwareAttribute2 = new SoftwareAttribute();
softwareAttribute2.setSoftware("some other software".getBytes());
//test positive equals
assertNotEquals(softwareAttribute2, softwareAttribute);
assertFalse("testequals failed",
softwareAttribute.equals(softwareAttribute2));
//test null equals
assertNotEquals(softwareAttribute, null);
assertFalse("testequals failed",
softwareAttribute.equals(null));
}
/**
* Tests extracting data length
*/
@Test
public void testGetDataLength()
{
char expectedReturn = (char)softwareValue.length();
char actualReturn = softwareAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn);
assertEquals("getDataLength - failed", expectedReturn, actualReturn);
}
/**
* Tests getting the name
*/
@Test
public void testGetName()
{
assertEquals("SOFTWARE", softwareAttribute.getName());
String expectedReturn = "SOFTWARE";
String actualReturn = softwareAttribute.getName();
assertEquals("getting name failed", expectedReturn, actualReturn);
}
@Test
public void testSetGetSoftware()
{
byte[] expectedReturn = softwareValue.getBytes();
@ -131,7 +137,8 @@ public class SoftwareAttributeTest
att.setSoftware(expectedReturn);
byte[] actualReturn = att.getSoftware();
assertArrayEquals(expectedReturn, actualReturn,
"software setter or getter failed");
assertTrue("software setter or getter failed",
Arrays.equals( expectedReturn,
actualReturn));
}
}

View File

@ -17,48 +17,57 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Tests the UNKNOWN attribute class.
*
* @author Emil Ivov
*/
public class UnknownAttributesAttributeTest
public class UnknownAttributesAttributeTest extends TestCase
{
private UnknownAttributesAttribute unknownAttributesAttribute = null;
private MsgFixture binMessagesFixture;
@BeforeEach
public void setUp() throws Exception
public UnknownAttributesAttributeTest(String name)
{
unknownAttributesAttribute = new UnknownAttributesAttribute();
binMessagesFixture = new MsgFixture();
super(name);
}
@AfterEach
public void tearDown() throws Exception
protected void setUp() throws Exception
{
super.setUp();
unknownAttributesAttribute = new UnknownAttributesAttribute();
binMessagesFixture = new MsgFixture();
binMessagesFixture.setUp();
}
protected void tearDown() throws Exception
{
unknownAttributesAttribute = null;
binMessagesFixture.tearDown();
binMessagesFixture = null;
super.tearDown();
}
//-------------------------------- TESTS ---------------------------------------
/**
* Verify the the constructed object has the correct (UNKNOWN-ATTRIBUTES)
* type.
*/
@Test
public void testUnknownAttributesAttribute()
{
unknownAttributesAttribute = new UnknownAttributesAttribute();
assertEquals(
Attribute.UNKNOWN_ATTRIBUTES,
(int) unknownAttributesAttribute.getAttributeType(),
"UnknownAttributesAttribute() did not properly set the Attribute's type field!"
assertEquals("UnknownAttributesAttribute() did not properly set the "
+"Attribute's type field!",
(int)Attribute.UNKNOWN_ATTRIBUTES,
(int)unknownAttributesAttribute.getAttributeType()
);
}
@ -67,40 +76,37 @@ public class UnknownAttributesAttributeTest
* and that a second addition of the same id would not augment the attribute
* count.
*/
@Test
public void testAddAttributeID()
{
char attributeID = 0x22; // unknown attribute id
unknownAttributesAttribute.addAttributeID(attributeID);
assertEquals(
assertEquals("addAttributeID does not seem to properly add the attribute ID",
(int)attributeID,
(int) unknownAttributesAttribute.getAttribute(0),
"addAttributeID does not seem to properly add the attribute ID"
(int)unknownAttributesAttribute.getAttribute(0)
);
assertEquals(
assertEquals("addAttributeID does not seem to properly add the attribute ID",
1,
unknownAttributesAttribute.getAttributeCount(),
"addAttributeID does not seem to properly add the attribute ID"
unknownAttributesAttribute.getAttributeCount()
);
//add a second one
unknownAttributesAttribute.addAttributeID(attributeID);
assertEquals(
assertEquals("Adding a 2nd time the same attributeID should not change "
+"the number of attributes",
1,
unknownAttributesAttribute.getAttributeCount(),
"Adding a 2nd time the same attributeID should not change the number of attributes"
unknownAttributesAttribute.getAttributeCount()
);
}
/**
* Tests whether a sample binary array is properly decoded.
* @throws StunException if anything goes wrong.
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
//a copy of the array in the fixture:
@ -112,36 +118,30 @@ public class UnknownAttributesAttributeTest
- Attribute.HEADER_LENGTH));
//is every one there?
assertTrue(
"The " + (int)MsgFixture.UNKNOWN_ATTRIBUTES_1ST_ATT +" attribute id "
+ "was not found after decoding a binary array that contained it.",
unknownAttributesAttribute.contains(
MsgFixture.UNKNOWN_ATTRIBUTES_1ST_ATT),
"The " + (int) MsgFixture.UNKNOWN_ATTRIBUTES_1ST_ATT
+ " attribute id "
+ "was not found after decoding a binary array that contained it."
);
MsgFixture.UNKNOWN_ATTRIBUTES_1ST_ATT));
assertTrue(
"The " + (int)MsgFixture.UNKNOWN_ATTRIBUTES_2ND_ATT +" attribute id "
+ "was not found after decoding a binary array that contained it.",
unknownAttributesAttribute.contains(
MsgFixture.UNKNOWN_ATTRIBUTES_2ND_ATT),
"The " + (int) MsgFixture.UNKNOWN_ATTRIBUTES_2ND_ATT
+ " attribute id "
+ "was not found after decoding a binary array that contained it."
);
MsgFixture.UNKNOWN_ATTRIBUTES_2ND_ATT));
assertTrue(
"The " + (int)MsgFixture.UNKNOWN_ATTRIBUTES_3D_ATT +" attribute id "
+ "was not found after decoding a binary array that contained it.",
unknownAttributesAttribute.contains(
MsgFixture.UNKNOWN_ATTRIBUTES_3D_ATT),
"The " + (int) MsgFixture.UNKNOWN_ATTRIBUTES_3D_ATT
+ " attribute id "
+ "was not found after decoding a binary array that contained it."
);
MsgFixture.UNKNOWN_ATTRIBUTES_3D_ATT));
assertEquals(
MsgFixture.UNKNOWN_ATTRIBUTES_CNT_DEC_TST,
unknownAttributesAttribute.getAttributeCount(),
"The decoded attribute contained "
assertEquals("The decoded attribute contained "
+ unknownAttributesAttribute.getAttributeCount()
+ " attribute ids when there were only "
+ (int)MsgFixture.UNKNOWN_ATTRIBUTES_CNT_DEC_TST
+ " in the original binary array."
+ " in the original binary array.",
MsgFixture.UNKNOWN_ATTRIBUTES_CNT_DEC_TST,
unknownAttributesAttribute.getAttributeCount()
);
}
@ -149,7 +149,6 @@ public class UnknownAttributesAttributeTest
* Creates a new UnknownAttributesAttribute encodes it and assert equality
* with binMessagesFixture.unknownAttsEncodeExpectedResult.
*/
@Test
public void testEncode()
{
byte[] expectedReturn = binMessagesFixture.unknownAttsEncodeExpectedResult;
@ -159,36 +158,46 @@ public class UnknownAttributesAttributeTest
unknownAttributesAttribute.addAttributeID(
MsgFixture.UNKNOWN_ATTRIBUTES_2ND_ATT);
byte[] actualReturn = unknownAttributesAttribute.encode();
assertArrayEquals(actualReturn, expectedReturn);
assertTrue("UnknownAttributesAttribute did not encode properly.",
Arrays.equals(actualReturn, expectedReturn));
}
/**
* Tests the equals method against a null, a different and an identical
* object.
*/
@Test
public void testEquals()
{
UnknownAttributesAttribute target = new UnknownAttributesAttribute();
assertNotEquals(unknownAttributesAttribute, null);
boolean expectedReturn = false;
boolean actualReturn = unknownAttributesAttribute.equals(null);
assertEquals("Equals failed for a null object",
expectedReturn, actualReturn);
unknownAttributesAttribute.addAttributeID((char)25);
target.addAttributeID((char)25);
unknownAttributesAttribute.addAttributeID((char)26);
assertNotEquals(unknownAttributesAttribute, target);
actualReturn = unknownAttributesAttribute.equals(target);
assertEquals("Equals failed when comparing different objects.",
expectedReturn, actualReturn);
target.addAttributeID((char)26);
assertEquals(unknownAttributesAttribute, target);
expectedReturn = true;
actualReturn = unknownAttributesAttribute.equals(target);
assertEquals("Equals failed to recognize identical objects.",
expectedReturn, actualReturn);
}
/**
* Tests that getAttribute() return the correct attribute id, preserving
* entry order.
*/
@Test
public void testGetAttribute()
{
char expectedId1 = 20;
@ -203,15 +212,14 @@ public class UnknownAttributesAttributeTest
actualId1 = unknownAttributesAttribute.getAttribute(0);
actualId2 = unknownAttributesAttribute.getAttribute(1);
assertEquals(expectedId1, actualId1, "getAttribute() return value mismatch");
assertEquals(expectedId2, actualId2, "getAttribute() return value mismatch");
assertEquals("getAttribute() return value mismatch", expectedId1, actualId1);
assertEquals("getAttribute() return value mismatch", expectedId2, actualId2);
}
/**
* Add some attributes and test whether their number is properly calculated.
* Tests duplicate id handling as well.
*/
@Test
public void testGetAttributeCount()
{
int expectedReturn = 5;
@ -224,15 +232,14 @@ public class UnknownAttributesAttributeTest
unknownAttributesAttribute.addAttributeID((char)25);//duplicate values should be ignored
int actualReturn = unknownAttributesAttribute.getAttributeCount();
assertEquals(expectedReturn, actualReturn,
"getAttributeCount did not return the expected value");
assertEquals("getAttributeCount did not return the expected value",
expectedReturn, actualReturn);
}
/**
* Same as testGetAttributeID, only attribute attributes are extracted
* through the getAttributes()'s iterator.
*/
@Test
public void testGetAttributes()
{
char expectedId1 = 20;
@ -249,8 +256,10 @@ public class UnknownAttributesAttributeTest
actualId1 = iterator.next();
actualId2 = iterator.next();
assertEquals(expectedId1, actualId1, "getAttributes() return value mismatch");
assertEquals(expectedId2, actualId2, "getAttributes() return value mismatch");
assertEquals("getAttributes() return value mismatch", expectedId1, actualId1);
assertEquals("getAttributes() return value mismatch", expectedId2, actualId2);
}
/**
@ -258,7 +267,6 @@ public class UnknownAttributesAttributeTest
* Test is first performed for an odd number of attributes and then again
* (after adding another attribute id). Both results should be the same.
*/
@Test
public void testGetDataLength()
{
char expectedReturn = 8;
@ -268,23 +276,25 @@ public class UnknownAttributesAttributeTest
unknownAttributesAttribute.addAttributeID((char)22);
char actualReturn = unknownAttributesAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Incorrect testGetDataLength() return value");
assertEquals("Incorrect testGetDataLength() return value",
expectedReturn, actualReturn);
unknownAttributesAttribute.addAttributeID((char)23);
actualReturn = unknownAttributesAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn,
"Incorrect testGetDataLength() return value");
assertEquals("Incorrect testGetDataLength() return value",
expectedReturn, actualReturn);
}
/**
* Tests whether getName returns a relevant name.
*/
@Test
public void testGetName()
{
assertEquals("UNKNOWN-ATTRIBUTES", unknownAttributesAttribute.getName());
String expectedReturn = "UNKNOWN-ATTRIBUTES";
String actualReturn = unknownAttributesAttribute.getName();
assertEquals("getName() return", expectedReturn, actualReturn);
}
}

View File

@ -17,17 +17,19 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* Tests the username attribute class.
*
* @author Emil Ivov
* @author Sebastien Vincent
*/
public class UsernameAttributeTest
public class UsernameAttributeTest extends TestCase
{
private UsernameAttribute usernameAttribute = null;
MsgFixture msgFixture = null;
@ -38,27 +40,30 @@ public class UsernameAttributeTest
0, (byte)usernameValue.length(),
'u', 's', 'e', 'r', 'n', 'a', 'm','e'};
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
usernameAttribute = new UsernameAttribute();
usernameAttribute.setUsername(usernameValue.getBytes());
msgFixture.setUp();
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
usernameAttribute = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Tests decoding of the username attribute.
* @throws StunException upon a failure
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
char offset = 0;
@ -67,62 +72,63 @@ public class UsernameAttributeTest
decoded.decodeAttributeBody(usernameValue.getBytes(), offset, length);
//username value
assertEquals(usernameAttribute, decoded);
assertEquals( "decode failed", usernameAttribute, decoded);
}
/**
* Tests the encode method
*/
@Test
public void testEncode()
{
assertArrayEquals(usernameAttribute.encode(), attributeBinValue);
assertTrue("encode failed",
Arrays.equals(usernameAttribute.encode(),
attributeBinValue));
}
/**
* Test Equals
*/
@Test
public void testEquals()
{
UsernameAttribute usernameAttribute2 = new UsernameAttribute();
usernameAttribute2.setUsername(usernameValue.getBytes());
//test positive equals
assertEquals(usernameAttribute, usernameAttribute2);
assertEquals("testequals failed", usernameAttribute, usernameAttribute2);
//test negative equals
usernameAttribute2 = new UsernameAttribute();
usernameAttribute2.setUsername("some other username".getBytes());
//test positive equals
assertNotEquals(usernameAttribute2, usernameAttribute);
assertFalse("testequals failed",
usernameAttribute.equals(usernameAttribute2));
//test null equals
assertNotEquals(usernameAttribute, null);
assertFalse("testequals failed",
usernameAttribute.equals(null));
}
/**
* Tests extracting data length
*/
@Test
public void testGetDataLength()
{
char expectedReturn = (char)usernameValue.length();
char actualReturn = usernameAttribute.getDataLength();
assertEquals(expectedReturn, actualReturn);
assertEquals("getDataLength - failed", expectedReturn, actualReturn);
}
/**
* Tests getting the name
*/
@Test
public void testGetName()
{
assertEquals("USERNAME", usernameAttribute.getName());
String expectedReturn = "USERNAME";
String actualReturn = usernameAttribute.getName();
assertEquals("getting name failed", expectedReturn, actualReturn);
}
@Test
public void testSetGetUsername()
{
byte[] expectedReturn = usernameValue.getBytes();
@ -131,7 +137,8 @@ public class UsernameAttributeTest
att.setUsername(expectedReturn);
byte[] actualReturn = att.getUsername();
assertArrayEquals(expectedReturn, actualReturn,
"username setter or getter failed");
assertTrue("username setter or getter failed",
Arrays.equals( expectedReturn,
actualReturn));
}
}

View File

@ -17,30 +17,32 @@
*/
package org.ice4j.attribute;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import java.util.*;
import org.ice4j.*;
import org.junit.jupiter.api.*;
/**
* @author Emil Ivov
*/
public class XorOnlyTest
public class XorOnlyTest extends TestCase
{
private XorOnlyAttribute xorOnly = null;
private MsgFixture msgFixture = null;
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
xorOnly = new XorOnlyAttribute();
msgFixture = new MsgFixture();
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
xorOnly = null;
msgFixture = null;
super.tearDown();
}
/**
@ -48,7 +50,6 @@ public class XorOnlyTest
* decode method doesn't do anything in the XorOnly att.
* @throws StunException if sth happens
*/
@Test
public void testDecodeAttributeBody() throws StunException
{
byte[] attributeValue = new byte[]{};
@ -60,52 +61,52 @@ public class XorOnlyTest
/**
* Test encoding XorOnly attributes.
*/
@Test
public void testEncode()
{
byte[] expectedReturn = new byte[]{Attribute.XOR_ONLY>>8,
Attribute.XOR_ONLY&0x00FF,
0, 0};
byte[] actualReturn = xorOnly.encode();
assertArrayEquals(expectedReturn, actualReturn);
assertTrue("XorOnly failed to encode",
Arrays.equals( expectedReturn, actualReturn));
}
/**
* Test positive and negative XorOnly.equals() returns
* @throws Exception if decoding fails
*/
@Test
public void testEquals() throws Exception
{
XorOnlyAttribute xor2 = new XorOnlyAttribute();
assertEquals(xorOnly, xor2);
assertEquals("equals() failes for XorOnly", xorOnly, xor2);
MappedAddressAttribute maatt = new MappedAddressAttribute();
maatt.decodeAttributeBody( msgFixture.mappedAddress,
(char) 0,
(char) msgFixture.mappedAddress.length );
assertNotEquals(maatt, xorOnly);
assertNotEquals(xorOnly, null);
assertFalse("equals failed to see a difference", xorOnly.equals(maatt));
assertFalse("equals failed for null", xorOnly.equals(null));
}
/**
* Makes sure the data langth is 0
*/
@Test
public void testGetDataLength()
{
char expectedReturn = 0;
char actualReturn = xorOnly.getDataLength();
assertEquals(expectedReturn, actualReturn, "data length was not 0");
assertEquals("data length was not 0", expectedReturn, actualReturn);
}
/**
* Verifies the name (do we really need this?).
*/
@Test
public void testGetName()
{
assertEquals("XOR-ONLY", xorOnly.getName());
String expectedReturn = "XOR-ONLY";
String actualReturn = xorOnly.getName();
assertEquals("Is name correct", expectedReturn, actualReturn);
}
}

View File

@ -17,42 +17,12 @@
*/
package org.ice4j.ice;
import static org.junit.jupiter.api.Assertions.*;
import static org.junit.Assert.*;
import org.junit.jupiter.api.*;
import org.junit.*;
public class NetworkUtilsTest
{
@Test
public void testIpv4StringToBytes()
{
byte[] addr = NetworkUtils.strToIPv4("1");
assertArrayEquals(new byte[]{0, 0, 0, 1}, addr);
addr = NetworkUtils.strToIPv4("1.2");
assertArrayEquals(new byte[]{1, 0, 0, 2}, addr);
addr = NetworkUtils.strToIPv4("1.2.3");
assertArrayEquals(new byte[]{1, 2, 0, 3}, addr);
addr = NetworkUtils.strToIPv4("1.2.3.4");
assertArrayEquals(new byte[]{1, 2, 3, 4}, addr);
assertNull(NetworkUtils.strToIPv4(""));
assertNull(NetworkUtils.strToIPv4("-1"));
assertNull(NetworkUtils.strToIPv4("1.-2"));
assertNull(NetworkUtils.strToIPv4("-1.2"));
assertNull(NetworkUtils.strToIPv4("1.-2.3"));
assertNull(NetworkUtils.strToIPv4("1.2.-3"));
assertNull(NetworkUtils.strToIPv4("-1.2.3"));
assertNull(NetworkUtils.strToIPv4("1.-2.3.4"));
assertNull(NetworkUtils.strToIPv4("1.2.-3.4"));
assertNull(NetworkUtils.strToIPv4("1.2.3.-4"));
assertNull(NetworkUtils.strToIPv4("-1.2.3.4"));
assertNull(NetworkUtils.strToIPv4("1.2.3.4.5"));
assertNull(NetworkUtils.strToIPv4("1.2.3.256"));
}
@Test
public void testIpv6StringToBytes()
{
@ -72,13 +42,6 @@ public class NetworkUtilsTest
assertNotNull(addr);
assertEquals(18, addr[15]);
assertNull(NetworkUtils.strToIPv6(""));
assertNull(NetworkUtils.strToIPv6(":::"));
assertNull(NetworkUtils.strToIPv6("[^"));
assertNull(NetworkUtils.strToIPv6("[%"));
assertNull(NetworkUtils.strToIPv6(":?0"));
assertNull(NetworkUtils.strToIPv6("[::12]%1"));
assertNull(NetworkUtils.strToIPv6("[::65536]%1"));
assertNull(NetworkUtils.strToIPv6("1111:222:3333:4444:5555:6666:7"));
}
}

View File

@ -1,196 +0,0 @@
/*
* ice4j, the OpenSource Java Solution for NAT and Firewall Traversal.
*
* Copyright @ 2019 8x8, Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ice4j.ice;
import static org.junit.jupiter.api.Assertions.*;
import org.ice4j.*;
import java.io.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.logging.*;
import org.junit.jupiter.api.*;
/**
* RoleConflictResolutionTest set of tests which does end-to-end test
* of ICE role conflict recovery.
*
* @author Yura Yaroshevich
*/
public class RoleConflictResolutionTest
{
protected static final Logger logger
= Logger.getLogger(RoleConflictResolutionTest.class.getName());
@Test
public void testRecoveryFromBothControlledConflict()
throws Throwable
{
testRecoveryFromRoleConflict(false);
}
@Test
public void testRecoveryFromBothControllingConflict()
throws Throwable
{
testRecoveryFromRoleConflict(true);
}
private static void testRecoveryFromRoleConflict(boolean bothControlling)
throws Throwable
{
final Agent peer1 = createPeer("[peer-1]", bothControlling);
// Set explicit tie-breakers to avoid automatic conflict resolution
peer1.setTieBreaker(1);
final Agent peer2 = createPeer("[peer-2]", bothControlling);
peer1.setTieBreaker(2);
final CountDownLatch countDownLatch = new CountDownLatch(2);
for (Agent peer : Arrays.asList(peer1, peer2))
{
peer.addStateChangeListener(evt ->
{
logger.info(peer.toString() + ": state changed to "
+ evt.toString());
if (peer.getState().isEstablished())
{
countDownLatch.countDown();
}
});
}
exchangeCredentials(peer1, peer2);
exchangeCandidates(peer1, peer2);
peer1.startConnectivityEstablishment();
peer2.startConnectivityEstablishment();
boolean isConnected = countDownLatch.await(20, TimeUnit.SECONDS);
logSelectedPairs(peer1);
logSelectedPairs(peer2);
assertTrue(isConnected,
"Expected connection established within time out");
assertTrue(peer1.getState().isEstablished(),
"peer 1 connectivity");
assertTrue(peer2.getState().isEstablished(),
"peer 2 connectivity");
disposePeer(peer1);
disposePeer(peer2);
}
private static Agent createPeer(String label, boolean iceControlling)
throws IOException
{
final Agent agent = new Agent(label, null);
agent.setControlling(iceControlling);
IceMediaStream iceStream = agent.createMediaStream("media-stream");
agent.createComponent(
iceStream,
0x400, 0x400, 0xFFFF,
KeepAliveStrategy.ALL_SUCCEEDED,
true);
return agent;
}
private static void disposePeer(Agent peer)
{
peer.free();
}
private static void logSelectedPairs(Agent peer)
{
for (IceMediaStream stream : peer.getStreams())
{
for (Component component : stream.getComponents())
{
CandidatePair selectedPair = component.getSelectedPair();
if (selectedPair != null)
{
logger.info(
peer + ": selected pair for " + "component " + component.getName() + " :" + selectedPair);
}
}
}
}
private static void exchangeCredentials(Agent peer1, Agent peer2)
{
for(IceMediaStream stream : peer2.getStreams())
{
stream.setRemoteUfrag(peer1.getLocalUfrag());
stream.setRemotePassword(peer1.getLocalPassword());
}
for(IceMediaStream stream : peer1.getStreams())
{
stream.setRemoteUfrag(peer2.getLocalUfrag());
stream.setRemotePassword(peer2.getLocalPassword());
}
}
private static void exchangeCandidates(Agent peer1, Agent peer2)
{
for (String streamName : peer1.getStreamNames())
{
IceMediaStream peer1Stream = peer1.getStream(streamName);
IceMediaStream peer2Stream = peer2.getStream(streamName);
if (peer1Stream == null || peer2Stream == null)
{
continue;
}
for (Integer id : peer1Stream.getComponentIDs())
{
Component peer1Component = peer1Stream.getComponent(id);
Component peer2Component = peer2Stream.getComponent(id);
if (peer1Component == null || peer2Component == null)
{
continue;
}
copyRemoteCandidates(peer1Component, peer2Component);
copyRemoteCandidates(peer2Component, peer1Component);
}
}
}
private static void copyRemoteCandidates(Component localComponent,
Component remoteComponent)
{
for(LocalCandidate candidate : remoteComponent.getLocalCandidates())
{
localComponent.addRemoteCandidate(
new RemoteCandidate(
candidate.getTransportAddress(),
localComponent,
candidate.getType(),
candidate.getFoundation(),
candidate.getPriority(),
null));
}
}
}

View File

@ -17,12 +17,10 @@
*/
package org.ice4j.ice.harvest;
import static org.junit.jupiter.api.Assertions.*;
import org.ice4j.*;
import org.junit.*;
import java.net.*;
import org.junit.jupiter.api.*;
/**
* Various tests that verify the functionality provided by {@link SinglePortUdpHarvester}.
@ -36,8 +34,8 @@ public class SinglePortUdpHarvesterTest
*
* @see <a href="https://github.com/jitsi/ice4j/issues/139">https://github.com/jitsi/ice4j/issues/139</a>
*/
@Test
public void testRebindWithoutCloseThrows() throws Exception
@Test( expected = java.net.BindException.class )
public void testRebindWithoutClose() throws Exception
{
// Setup test fixture.
final TransportAddress address = new TransportAddress( "127.0.0.1", 10000, Transport.UDP );
@ -46,7 +44,7 @@ public class SinglePortUdpHarvesterTest
{
firstHarvester = new SinglePortUdpHarvester( address );
}
catch (BindException ex)
catch ( java.net.BindException ex )
{
// This is not expected at this stage (the port is likely already in use by another process, voiding this
// test). Rethrow as a different exception than the BindException, that is expected to be thrown later in
@ -59,15 +57,12 @@ public class SinglePortUdpHarvesterTest
try
{
secondHarvester = new SinglePortUdpHarvester( address );
fail("expected BindException to be thrown at this point");
}
catch (BindException ex)
{
//expected, do nothing
}
// Verification of the results is implicit - this Test expectes BindException to be thrown at this point.
// Tear down
finally
{
// Tear down
firstHarvester.close();
if ( secondHarvester != null )
{
@ -101,7 +96,7 @@ public class SinglePortUdpHarvesterTest
// Verify results.
catch ( BindException ex )
{
fail( "A bind exception should not have been thrown, as the original harvester was properly closed.");
Assert.fail( "A bind exception should not have been thrown, as the original harvester was propertly closed.");
}
// Tear down.
@ -113,29 +108,4 @@ public class SinglePortUdpHarvesterTest
}
}
}
@Test
public void testBindWithPortZero() throws Exception
{
// Setup test fixture.
final TransportAddress address = new TransportAddress("127.0.0.1", 0, Transport.UDP);
SinglePortUdpHarvester harvester;
try
{
harvester = new SinglePortUdpHarvester(address);
}
catch (BindException ex)
{
// This is not expected at this stage.
// Rethrow as a different exception than the BindException, that is expected to be thrown later in
// this test.
throw new Exception("Test fixture is invalid.", ex);
}
assertFalse(harvester.localAddress.getPort() == 0,
"A random port number not equal to zero should have been chosen by the OS");
// Tear down
harvester.close();
}
}

View File

@ -17,15 +17,36 @@
*/
package org.ice4j.message;
import static org.junit.jupiter.api.Assertions.*;
import junit.framework.*;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.junit.jupiter.api.*;
public class MessageFactoryTest
public class MessageFactoryTest extends TestCase
{
@Test
private MsgFixture msgFixture;
public MessageFactoryTest(String name)
{
super(name);
}
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
msgFixture.setUp();
}
protected void tearDown() throws Exception
{
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
public void testCreateBindingErrorResponse() throws StunException
{
char errorCode = 400;
@ -39,11 +60,10 @@ public class MessageFactoryTest
Message actualReturn
= MessageFactory.createBindingErrorResponse(errorCode);
assertEquals(expectedReturn, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
@Test
public void testCreateBindingErrorResponse1()
public void testCreateBindingErrorResponse1() throws StunException
{
char errorCode = 400;
String reasonPhrase = "Bad Request";
@ -57,10 +77,10 @@ public class MessageFactoryTest
Message actualReturn = MessageFactory
.createBindingErrorResponse(errorCode, reasonPhrase);
assertEquals(expectedReturn, actualReturn);
assertEquals("Failed to create an error code attribute.",
expectedReturn, actualReturn);
}
@Test
public void testCreateBindingErrorResponseUnknownAttributes()
throws StunException
{
@ -71,18 +91,17 @@ public class MessageFactoryTest
Response expectedReturn = new Response();
expectedReturn.setMessageType(Message.BINDING_ERROR_RESPONSE);
ErrorCodeAttribute errorCodeAtt = AttributeFactory
Attribute errorCodeAtt = AttributeFactory
.createErrorCodeAttribute(errorCode);
errorCodeAtt.setReasonPhrase(
((ErrorCodeAttribute)errorCodeAtt).setReasonPhrase(
ErrorCodeAttribute.getDefaultReasonPhrase(errorCode));
expectedReturn.putAttribute(errorCodeAtt);
UnknownAttributesAttribute unknownAtts =
AttributeFactory.createUnknownAttributesAttribute();
for (char unknownAttribute : unknownAttributes)
{
unknownAtts.addAttributeID(unknownAttribute);
for (int i = 0; i < unknownAttributes.length; i++) {
unknownAtts.addAttributeID(unknownAttributes[i]);
}
expectedReturn.putAttribute(unknownAtts);
@ -90,10 +109,9 @@ public class MessageFactoryTest
Message actualReturn = MessageFactory
.createBindingErrorResponseUnknownAttributes(unknownAttributes);
//compare
assertEquals(expectedReturn, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
@Test
public void testCreateBindingErrorResponseUnknownAttributes1()
throws StunException
{
@ -111,22 +129,22 @@ public class MessageFactoryTest
UnknownAttributesAttribute unknownAtts =
AttributeFactory.createUnknownAttributesAttribute();
for (char unknownAttribute : unknownAttributes)
for (int i = 0; i < unknownAttributes.length; i++)
{
unknownAtts.addAttributeID(unknownAttribute);
unknownAtts.addAttributeID(unknownAttributes[i]);
}
expectedReturn.putAttribute(unknownAtts);
Message actualReturn = MessageFactory
.createBindingErrorResponseUnknownAttributes(
reasonPhrase, unknownAttributes);
assertEquals(expectedReturn, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
@Test
public void testCreateBindingRequest()
public void testCreateBindingRequest() throws StunException
{
Request bindingRequest = new Request();
Request expectedReturn = bindingRequest;
bindingRequest.setMessageType(Message.BINDING_REQUEST);
/*
Attribute changeRequest = AttributeFactory.createChangeRequestAttribute(
@ -134,10 +152,9 @@ public class MessageFactoryTest
bindingRequest.putAttribute(changeRequest);
*/
Request actualReturn = MessageFactory.createBindingRequest();
assertEquals(bindingRequest, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
@Test
public void testCreateBindingResponse()
throws Exception
{
@ -166,6 +183,7 @@ public class MessageFactoryTest
bindingResponse.putAttribute(changedAddress);
Message expectedReturn = bindingResponse;
Message actualReturn = MessageFactory.create3489BindingResponse(
new TransportAddress( MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS,
MsgFixture.ADDRESS_ATTRIBUTE_PORT,
@ -176,6 +194,6 @@ public class MessageFactoryTest
new TransportAddress( MsgFixture.ADDRESS_ATTRIBUTE_ADDRESS_3,
MsgFixture.ADDRESS_ATTRIBUTE_PORT_3,
Transport.UDP));
assertEquals(bindingResponse, actualReturn);
assertEquals("return value", expectedReturn, actualReturn);
}
}

View File

@ -17,32 +17,16 @@
*/
package org.ice4j.message;
import static org.junit.jupiter.api.Assertions.*;
import java.util.*;
import junit.framework.*;
import org.ice4j.*;
import org.ice4j.attribute.*;
import org.ice4j.stack.*;
import org.jitsi.config.*;
import org.junit.jupiter.api.*;
public class MessageTest
public class MessageTest extends TestCase
{
@BeforeAll
public static void setupConfig()
{
System.clearProperty(StackProperties.ALWAYS_SIGN);
System.setProperty("ice4j.software", "");
JitsiConfig.Companion.reloadNewConfig();
}
@AfterAll
public static void resetConfig()
{
System.clearProperty("ice4j.software");
JitsiConfig.Companion.reloadNewConfig();
}
private Message bindingRequest = null;
private Message bindingResponse = null;
@ -59,10 +43,12 @@ public class MessageTest
*/
private StunStack stunStack;
@BeforeEach
public void setUp() throws Exception
protected void setUp() throws Exception
{
super.setUp();
msgFixture = new MsgFixture();
msgFixture.setUp();
stunStack = new StunStack();
@ -103,8 +89,7 @@ public class MessageTest
bindingResponse.setTransactionID(MsgFixture.TRANSACTION_ID);
}
@AfterEach
public void tearDown() throws Exception
protected void tearDown() throws Exception
{
bindingRequest = null;
bindingResponse = null;
@ -112,38 +97,48 @@ public class MessageTest
sourceAddress = null;
changedAddress = null;
changeRequest = null;
changeRequest = null;
stunStack = null;
msgFixture.tearDown();
msgFixture = null;
super.tearDown();
}
/**
* Adds and gets an attribute and test that they are the same then adds a
* another attribute (same typ different value) and verifies that the first
* another attribute (same typ different value) and veriies that the first
* one is properly replaced.
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testAddAndGetAttribute()
public void testAddAndGetAttribute() throws StunException
{
Response message = new Response();
message.setMessageType(Message.BINDING_SUCCESS_RESPONSE);
message.putAttribute(mappedAddress);
Attribute getResult;
Attribute getResult = null;
getResult = message.getAttribute(mappedAddress.getAttributeType());
assertEquals(mappedAddress, getResult,
"Originally added attribute did not match the returned");
assertEquals("Originally added attribute did not match the one retrned "
+"by getAttribute()",
mappedAddress,
getResult);
//do it again
message.putAttribute(sourceAddress);
getResult = message.getAttribute(sourceAddress.getAttributeType());
assertEquals(sourceAddress, getResult,
"The second attribute could not be extracted.");
assertEquals("The second attribute could not be extracted.",
sourceAddress,
getResult);
}
/**
@ -152,7 +147,6 @@ public class MessageTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testEncode()
throws StunException
{
@ -160,16 +154,16 @@ public class MessageTest
byte[] expectedReturn = msgFixture.bindingRequest;
byte[] actualReturn = bindingRequest.encode(stunStack);
assertArrayEquals(expectedReturn, actualReturn,
"A binding request was not properly encoded");
assertTrue("A binding request was not properly encoded",
Arrays.equals( expectedReturn, actualReturn ) );
//Binding Response
expectedReturn = msgFixture.bindingResponse;
actualReturn = bindingResponse.encode(stunStack);
assertArrayEquals(expectedReturn, actualReturn,
"A binding response was not properly encoded");
assertTrue("A binding response was not properly encoded",
Arrays.equals( expectedReturn, actualReturn ) );
}
/**
@ -178,7 +172,6 @@ public class MessageTest
*
* @throws Exception java.lang.Exception if we fail
*/
@Test
public void testDecode()
throws Exception
{
@ -186,21 +179,21 @@ public class MessageTest
Message expectedReturn = bindingRequest;
Message actualReturn = Message.decode(msgFixture.bindingRequest,
0,
msgFixture.bindingRequest.length);
(char)0,
(char)msgFixture.bindingRequest.length);
assertEquals(expectedReturn, actualReturn,
"A binding request was not properly decoded");
assertEquals("A binding request was not properly decoded",
expectedReturn, actualReturn );
//Binding Response
expectedReturn = bindingResponse;
actualReturn = Message.decode(msgFixture.bindingResponse,
0,
msgFixture.bindingResponse.length);
(char)0,
(char)msgFixture.bindingResponse.length);
assertEquals(expectedReturn, actualReturn,
"A binding response was not properly decoded");
assertEquals("A binding response was not properly decoded",
expectedReturn, actualReturn );
}
/**
@ -209,30 +202,39 @@ public class MessageTest
*
* @throws StunException java.lang.Exception if we fail
*/
@Test
public void testEquals()
throws StunException
{
assertNotEquals(bindingRequest, null,
"Equals failed against a null target");
Object target = null;
boolean expectedReturn = false;
boolean actualReturn = bindingRequest.equals(target);
assertEquals("Equals failed against a null target",
expectedReturn, actualReturn);
assertNotEquals(bindingResponse, null,
"Equals failed against a null target");
actualReturn = bindingResponse.equals(target);
assertEquals("Equals failed against a null target",
expectedReturn, actualReturn);
//different
assertNotEquals(bindingRequest, bindingResponse,
"Equals failed against a different target");
actualReturn = bindingRequest.equals(bindingResponse);
assertEquals("Equals failed against a different target",
expectedReturn, actualReturn);
assertNotEquals(bindingResponse, bindingRequest,
"Equals failed against a different target");
actualReturn = bindingResponse.equals(bindingRequest);
assertEquals("Equals failed against a different target",
expectedReturn, actualReturn);
//same
expectedReturn = true;
//Create a binding request with the same attributes as
//this.bindingRequest
Request binReqTarget = new Request();
binReqTarget.setMessageType(Message.BINDING_REQUEST);
binReqTarget.putAttribute(changeRequest);
assertEquals(bindingRequest, binReqTarget,
"Equals failed against an equal target");
actualReturn = bindingRequest.equals(binReqTarget);
assertEquals("Equals failed against an equal target",
expectedReturn, actualReturn);
//Create a binding response with the same attributes as
//this.bindingRequest
@ -241,42 +243,42 @@ public class MessageTest
binResTarget.putAttribute(mappedAddress);
binResTarget.putAttribute(sourceAddress);
binResTarget.putAttribute(changedAddress);
assertEquals(bindingResponse, binResTarget,
"Equals failed against a different target");
actualReturn = bindingResponse.equals(binResTarget);
assertEquals("Equals failed against a different target",
expectedReturn, actualReturn);
}
/**
* Tests whether attributes are properly counted
*/
@Test
public void testGetAttributeCount()
{
int expectedReturn = 1;
int actualReturn = bindingRequest.getAttributeCount();
assertEquals(expectedReturn, actualReturn,
"getAttributeCount failed for a bindingRequest");
assertEquals("getAttributeCount failed for a bindingRequest",
expectedReturn, actualReturn);
expectedReturn = 3;
actualReturn = bindingResponse.getAttributeCount();
assertEquals(expectedReturn, actualReturn,
"getAttributeCount failed for a bindingRequest");
assertEquals("getAttributeCount failed for a bindingRequest",
expectedReturn, actualReturn);
}
/**
* Test whether attributes are properly removed.
*/
@Test
public void testRemoveAttribute()
{
bindingRequest.removeAttribute(changeRequest.getAttributeType());
assertNull(bindingRequest.getAttribute(changeRequest.getAttributeType()),
"An attribute was still in the request after being removed");
assertNull("An attribute was still in the request after being removed",
bindingRequest.getAttribute(changeRequest.getAttributeType()));
//test count
int expectedReturn = 0;
int actualReturn = bindingRequest.getAttributeCount();
assertEquals(expectedReturn, actualReturn,
"Attribute count did not change after removing an attribute");
assertEquals(
"Attribute count did not change after removing an attribute",
expectedReturn, actualReturn);
}
}

View File

@ -17,31 +17,32 @@
*/
package org.ice4j.pseudotcp;
import static org.junit.jupiter.api.Assertions.*;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
import java.util.function.Function;
import java.util.function.Predicate;
import junit.framework.*;
/**
* This class enables multi thread tests where main thread waits in loop for
* specified condition to be met, while others perform some operations. For
* example until the connection is established or closed. It also registers
* default uncaught exception handler to catch exceptions from other threads.
* <p>
* This class enables multi thread tests where main thread waits in loop
* for specified condition to be met, while others perform some operations.
* For example until the connection is established or closed.
* It also registers default uncaught exception handler to catch exceptions
* from other threads.
*
* Condition checks are passed as IWaitUntilDone interface.
*
* @author Pawel Domas
*/
public class MultiThreadSupportTest implements Thread.UncaughtExceptionHandler
public class MultiThreadSupportTest
extends TestCase
implements Thread.UncaughtExceptionHandler
{
private volatile Throwable testError;
private volatile Thread errorThread;
private final Object testLock = new Object();
public MultiThreadSupportTest()
{
}
@Override
public void uncaughtException(Thread t, Throwable e)
{
@ -53,28 +54,30 @@ public class MultiThreadSupportTest implements Thread.UncaughtExceptionHandler
}
}
private static final long ASSERT_WAIT_INTERVAL = 100;
protected boolean assert_wait_until(BooleanSupplier wait, long timeoutMs)
private long assertWaitInterval = 100;
protected interface WaitUntilDone
{
public boolean isDone();
}
protected boolean assert_wait_until(WaitUntilDone wait, long timeoutMs)
{
long timeoutNanos = TimeUnit.MILLISECONDS.toNanos(timeoutMs);
try
{
long start = System.nanoTime();
while (!wait.getAsBoolean() && (System.nanoTime() - start) < timeoutNanos)
long start = System.currentTimeMillis();
while (!wait.isDone() && (System.currentTimeMillis() - start) < timeoutMs)
{
synchronized (testLock)
{
testLock.wait(ASSERT_WAIT_INTERVAL);
testLock.wait(assertWaitInterval);
if (testError != null)
{
testError.printStackTrace();
fail("Error in thread: " + errorThread.getName() + " : "
+ testError.getMessage());
fail("Error in thread: " + errorThread.getName() + " : " + testError.getMessage());
}
}
}
return wait.getAsBoolean();
return wait.isDone();
}
catch (InterruptedException ex)
{
@ -84,4 +87,6 @@ public class MultiThreadSupportTest implements Thread.UncaughtExceptionHandler
return false;
}
}
}

View File

@ -17,14 +17,16 @@
*/
package org.ice4j.pseudotcp;
import static org.junit.jupiter.api.Assertions.*;
import static org.junit.Assert.*;
import java.io.*;
import java.net.*;
import java.util.concurrent.atomic.*;
import java.util.logging.*;
import org.junit.jupiter.api.*;
/**
*
* @author Pawel Domas
*/
public class PseudoTcpStreamTest
extends MultiThreadSupportTest
{
@ -34,15 +36,19 @@ public class PseudoTcpStreamTest
private static final Logger logger = Logger
.getLogger(PseudoTcpStreamTest.class.getName());
public PseudoTcpStreamTest()
{
}
/**
* Test one-way transfer with @link(PseudoTcpStream)
* @throws IOException
*/
@Test
@Timeout(10)
public void testConnectTransferClose()
throws IOException
{
Thread.setDefaultUncaughtExceptionHandler(this);
final int server_port = 49999;
int transferTimeout = 5000;
// bytes that will be read as a single byte
@ -53,18 +59,19 @@ public class PseudoTcpStreamTest
final byte[] bufferA = PseudoTcpTestBase.createDummyData(sizeA);
final int sizeB = 983746;
final byte[] bufferB = PseudoTcpTestBase.createDummyData(sizeB);
final InetSocketAddress serverAddress =
new InetSocketAddress(InetAddress.getLocalHost(), server_port);
final PseudoTcpSocket server =
new PseudoTcpSocketFactory().createSocket();
server.setDebugName("L");
server.bind(new InetSocketAddress(InetAddress.getLoopbackAddress(), 0));
final InetSocketAddress serverAddress =
new InetSocketAddress(InetAddress.getLoopbackAddress(), server.getLocalPort());
AtomicBoolean clientThreadEnded = new AtomicBoolean();
AtomicBoolean serverThreadEnded = new AtomicBoolean();
Thread serverThread = new Thread(() ->
Thread serverThread = new Thread(new Runnable()
{
@Override
public void run()
{
try
{
server.setDebugName("L");
server.bind(serverAddress);
server.accept(5000);
byte[] rcvdSingle = new byte[singleStepCount];
// read by one byte
@ -80,31 +87,30 @@ public class PseudoTcpStreamTest
receiveBuffer(server.getInputStream(), sizeB);
assertArrayEquals(bufferB, recvdBufferB);
// server.close();
serverThreadEnded.set(true);
}
catch (IOException ex)
{
throw new RuntimeException(ex);
}
}
});
final PseudoTcpSocket client =
new PseudoTcpSocketFactory().createSocket();
Thread clientThread = new Thread(() ->
Thread clientThread = new Thread(new Runnable()
{
@Override
public void run()
{
try
{
client.setDebugName("R");
client.connect(serverAddress, 5000);
OutputStream os = client.getOutputStream();
// write single array
for (int i = 0; i < singleStepCount; i++)
os.write(bufferSingle[i]);
client.getOutputStream().write(bufferSingle[i]);
// write whole array
os.write(bufferA);
client.getOutputStream().write(bufferA);
// write by parts
int partCount = 7;
boolean notExact = sizeB % partCount != 0;
@ -118,41 +124,39 @@ public class PseudoTcpStreamTest
partsSize[i] = sizeB / partCount;
}
int written = 0;
for (int j : partsSize)
for (int i = 0; i < partsSize.length; i++)
{
os.write(bufferB, written, j);
written += j;
client.getOutputStream().write(bufferB, written,
partsSize[i]);
written += partsSize[i];
}
assertEquals(sizeB, written);
os.flush();
client.getOutputStream().flush();
client.close();
clientThreadEnded.set(true);
}
catch (IOException ex)
{
throw new RuntimeException(ex);
}
}
});
serverThread.start();
clientThread.start();
try
{
boolean success = assert_wait_until(
() -> client.getState() == PseudoTcpState.TCP_CLOSED,
transferTimeout);
boolean success = assert_wait_until(new WaitUntilDone()
{
@Override
public boolean isDone()
{
return client.getState() == PseudoTcpState.TCP_CLOSED;
}
}, transferTimeout);
if (success)
{
clientThread.join(10_000);
if (!clientThreadEnded.get())
{
fail("client thread did not end");
}
serverThread.join(10_000);
if (!serverThreadEnded.get())
{
fail("server thread did not end");
}
clientThread.join();
serverThread.join();
server.close();
}
else
@ -187,35 +191,52 @@ public class PseudoTcpStreamTest
/**
* Test the timeout on accept method
*/
@Test
public void testAccept()
{
assertThrows(IOException.class, ()->
try
{
PseudoTcpSocketImpl server = new PseudoTcpSocketImpl(0);
server.accept(10);
});
fail("Should throw timeout exception");
}
catch (IOException ex)
{
// success
}
}
/**
* Interface used to pass timeout test function
* @author Pawel Domas
*
*/
private interface TimeoutOperationTest
{
void testTimeout(PseudoTcpSocketImpl socket) throws IOException;
}
/**
*
* @param testOperation
* @throws UnknownHostException
*/
private void doTestTimeout(final TimeoutOperationTest testOperation)
throws Exception
{
Thread.setDefaultUncaughtExceptionHandler(this);
final PseudoTcpSocketImpl server;
final PseudoTcpSocketImpl client;
DatagramSocket serverSocket = new DatagramSocket(0, InetAddress.getLoopbackAddress());
server = new PseudoTcpSocketImpl(0, serverSocket);
final int server_port = 49998;
final InetSocketAddress serverAddress =
new InetSocketAddress(InetAddress.getLocalHost(), server_port);
server =
new PseudoTcpSocketImpl(0,new DatagramSocket(serverAddress));
client = new PseudoTcpSocketImpl(0);
//Servers thread waiting for connection
new Thread(() ->
new Thread(new Runnable()
{
@Override
public void run()
{
try
{
@ -228,7 +249,7 @@ public class PseudoTcpStreamTest
try
{
testOperation.testTimeout(server);
fail("No expected timeout occurred on operation");
fail("No expected timeout occured on operation");
}
catch (IOException e)
{
@ -242,16 +263,18 @@ public class PseudoTcpStreamTest
throw new RuntimeException(exc);
}
}
}
}).start();
//Clients thread connects and closes socket
new Thread(() ->
new Thread(new Runnable()
{
@Override
public void run()
{
try
{
client.connect(new InetSocketAddress(
InetAddress.getLoopbackAddress(),
serverSocket.getLocalPort()),
2000);
client.connect(serverAddress, 2000);
Thread.sleep(500);
client.close();
}
@ -259,10 +282,18 @@ public class PseudoTcpStreamTest
{
throw new RuntimeException(e);
}
}
}).start();
//Waits for server to close socket
boolean done = assert_wait_until(()
-> server.getState() == PseudoTcpState.TCP_CLOSED, 3000);
boolean done = assert_wait_until(new WaitUntilDone()
{
@Override
public boolean isDone()
{
return server.getState() == PseudoTcpState.TCP_CLOSED;
}
}, 3000);
if(!done)
{
fail("Test timed out");
@ -271,39 +302,51 @@ public class PseudoTcpStreamTest
/**
* Tests timeout on read method
* @throws UnknownHostException
*/
@Test
public void testReadTimeout() throws Exception
{
doTestTimeout(socket ->
doTestTimeout(new TimeoutOperationTest()
{
@Override
public void testTimeout(PseudoTcpSocketImpl socket) throws IOException
{
socket.setPTCPOption(Option.OPT_READ_TIMEOUT, 300);
socket.getInputStream().read(new byte[500]);
}
});
}
/**
* Tests timeout on write method
* @throws UnknownHostException
*/
@Test
public void testWriteTimeout() throws Exception
{
doTestTimeout(socket ->
doTestTimeout(new TimeoutOperationTest()
{
@Override
public void testTimeout(PseudoTcpSocketImpl socket) throws IOException
{
//buffer that will exceed stack's buffer size
byte[] bigBuffer = new byte[PseudoTCPBase.DEFAULT_SND_BUF_SIZE*2];
socket.setPTCPOption(Option.OPT_WRITE_TIMEOUT, 300);
socket.getOutputStream().write(bigBuffer);
}
});
}
/**
* Tests timeout on flush method
* @throws UnknownHostException
*/
@Test
public void testFlushTimeout() throws Exception
{
doTestTimeout(socket ->
doTestTimeout(new TimeoutOperationTest()
{
@Override
public void testTimeout(PseudoTcpSocketImpl socket) throws IOException
{
//buffer that will exceed stack's buffer size
byte[] buffer = new byte[PseudoTCPBase.DEFAULT_SND_BUF_SIZE];
@ -317,6 +360,8 @@ public class PseudoTcpStreamTest
throw new RuntimeException("Unexpected exception: "+e);
}
socket.getOutputStream().flush();
}
});
}
}

View File

@ -608,9 +608,9 @@ public abstract class PseudoTcpTestBase
runClocks = false;
localClockThread.interrupt();
remoteClockThread.interrupt();
localClockThread.join(5000);
localClockThread.join();
localClockThread = null;
remoteClockThread.join(5000);
remoteClockThread.join();
remoteClockThread = null;
}
catch (InterruptedException ex)
@ -633,9 +633,14 @@ public abstract class PseudoTcpTestBase
*/
protected boolean assert_Connected_wait(int kConnectTimeoutMs)
{
return assert_wait_until(
() -> PseudoTcpTestBase.this.have_connected_,
kConnectTimeoutMs);
return assert_wait_until(new WaitUntilDone()
{
@Override
public boolean isDone()
{
return PseudoTcpTestBase.this.have_connected_;
}
}, kConnectTimeoutMs);
}
/**
@ -647,9 +652,14 @@ public abstract class PseudoTcpTestBase
*/
protected boolean assert_Disconnected_wait(long kTransferTimeoutMs)
{
return assert_wait_until(
() -> PseudoTcpTestBase.this.have_disconnected_,
kTransferTimeoutMs);
return assert_wait_until(new WaitUntilDone()
{
@Override
public boolean isDone()
{
return PseudoTcpTestBase.this.have_disconnected_;
}
}, kTransferTimeoutMs);
}
/**

Some files were not shown because too many files have changed in this diff Show More