Merge pull request #108 from bgrozev/update-docs

Update docs
This commit is contained in:
bbaldino 2017-03-30 15:19:45 -07:00 committed by GitHub
commit 3547d35e9b

View File

@ -4,33 +4,33 @@ to configure itself.
## Interfaces and IP addresses ## Interfaces and IP addresses
### *org.ice4j.ice.harvest.ALLOWED_INTERFACES* ### ```org.ice4j.ice.harvest.ALLOWED_INTERFACES```
Default: all interfaces are allowed. Default: all interfaces are allowed.
This property can be used to specify a ";"-separated list of interfaces which are This property can be used to specify a ";"-separated list of interfaces which are
allowed to be used for candidate allocations. If not specified, all interfaces are allowed to be used for candidate allocations. If not specified, all interfaces are
considered allowed, unless they are explicitly blocked (see below). considered allowed, unless they are explicitly blocked (see below).
### *org.ice4j.ice.harvest.BLOCKED_INTERFACES* ### ```org.ice4j.ice.harvest.BLOCKED_INTERFACES```
Default: no interfaces are blocked. Default: no interfaces are blocked.
This property can be used to specify a ";"-separated list of interfaces which are This property can be used to specify a ";"-separated list of interfaces which are
not allowed to be used for candidate allocations. not allowed to be used for candidate allocations.
### *org.ice4j.ice.harvest.ALLOWED_ADDRESSES* ### ```org.ice4j.ice.harvest.ALLOWED_ADDRESSES```
Default: all addresses are allowed. Default: all addresses are allowed.
This property can be used to specify a ";"-separated list of IP addresses which This property can be used to specify a ";"-separated list of IP addresses which
are allowed to be used for candidate allocations. If not specified, all addresses are allowed to be used for candidate allocations. If not specified, all addresses
are considered allowed, unless they are explicitly blocked (see below). are considered allowed, unless they are explicitly blocked (see below).
### *org.ice4j.ice.harvest.BLOCKED_ADDRESSES* ### ```org.ice4j.ice.harvest.BLOCKED_ADDRESSES```
Default: no addresses are blocked. Default: no addresses are blocked.
This property can be used to specify a ";"-separated list of IP addresses which This property can be used to specify a ";"-separated list of IP addresses which
are not allowed to be used for candidate allocations. are not allowed to be used for candidate allocations.
### *org.ice4j.ipv6.DISABLED* ### ```org.ice4j.ipv6.DISABLED```
Type: boolean Type: boolean
Default: false Default: false
@ -53,27 +53,35 @@ Ice4j implements three types of mapping harvesters: one with a pre-configured pa
addresses, one two which discover addresses dynamically using the AWS API and STUN. addresses, one two which discover addresses dynamically using the AWS API and STUN.
### *org.ice4j.ice.harvest.NAT_HARVESTER_LOCAL_ADDRESS* ### ```org.ice4j.ice.harvest.NAT_HARVESTER_LOCAL_ADDRESS```
### *org.ice4j.ice.harvest.NAT_HARVESTER_PUBLIC_ADDRESS* ### ```org.ice4j.ice.harvest.NAT_HARVESTER_PUBLIC_ADDRESS```
Default: none Default: none
Configures the addresses of the pre-configured mapping harvester. Configures the addresses of the pre-configured mapping harvester.
### *org.ice4j.ice.harvest.DISABLE_AWS_HARVESTER* ### ```org.ice4j.ice.harvest.DISABLE_AWS_HARVESTER```
Default: false Default: false
Explicitly disables the AWS mapping harvester. By default the harvester Explicitly disables the AWS mapping harvester. By default the harvester
is enabled if ice4j detects that it is running in the AWS network. is enabled if ice4j detects that it is running in the AWS network.
### *org.ice4j.ice.harvest.FORCE_AWS_HARVESTER* ### ```org.ice4j.ice.harvest.FORCE_AWS_HARVESTER```
Default: false Default: false
Force the use of the AWS mapping harvester, even if ice4j did not detect Force the use of the AWS mapping harvester, even if ice4j did not detect
that it is running in the AWS network. that it is running in the AWS network.
### *org.ice4j.ice.harvest.STUN_MAPPING_HARVESTER_ADDRESSES* ### ```org.ice4j.ice.harvest.STUN_MAPPING_HARVESTER_ADDRESSES```
Default: none Default: none
A comma-separated list of STUN server addresses to use for mapping harvesters. A comma-separated list of STUN server addresses to use for mapping harvesters.
Each STUN server address is an ip_address:port pair. Each STUN server address is an ip_address:port pair.
Example: ```stun1.example.com:12345,stun2.example.com:23456``` Example: ```stun1.example.com:12345,stun2.example.com:23456```
## Single port UDP harvester
### ```org.ice4j.ice.harvest.AbstractUdpHarvester.SO_RCVBUF```
Configures the receive buffer size for the single port UDP harvester
(or other AbstractUdpListener implementations). If this is not set
the system default value will be used (the ```net.core.rmem_default```
sysctl parameter on linux). Note that the system maximum value may need to
be increased (```net.core.rmem_max``` on linux).