Class ConnectionOptions
- All Implemented Interfaces:
I2PSocketOptions
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
OK, here is the calculation on the message size to fit in a single tunnel message without fragmentation.static final int
See analysis in proposal 144(package private) static final int
static final int
static final int
static final int
on inactivity timeout, close the connectionstatic final int
on inactivity timeout, do nothingstatic final int
on inactivity timeout, send a payload message(package private) static final int
RFC 5681 sec.static final int
(package private) static final int
static final int
static final int
static final String
static final String
static final String
static final String
static final String
static final String
all of these are @since 0.7.13static final String
static final String
static final String
static final String
static final String
static final String
unusedstatic final String
static final String
static final String
static final String
static final String
static final String
all of these are @since 0.7.14static final String
static final String
static final String
how many streams will we allow at once?static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class net.i2p.client.streaming.impl.I2PSocketOptionsImpl
DEFAULT_BUFFER_SIZE, DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT, DEFAULT_WRITE_TIMEOUT
Fields inherited from interface net.i2p.client.streaming.I2PSocketOptions
PROP_BUFFER_SIZE, PROP_CONNECT_TIMEOUT, PROP_READ_TIMEOUT, PROP_WRITE_TIMEOUT
-
Constructor Summary
ConstructorDescriptionSets max buffer size, connect timeout, read timeout, and write timeout from System properties.ConnectionOptions
(Properties opts) Sets max buffer size, connect timeout, read timeout, and write timeout from properties.Initializes from System properties then copies over all options.Initializes from System properties then copies over all options. -
Method Summary
Modifier and TypeMethodDescription(package private) int
Double the RTO (after congestion).boolean
Do we respond to a ping?int
When we're in congestion avoidance, we grow the window size at the rate of 1/(windowSize*factor).int
how long will we wait after instantiating a new con before actually attempting to connect.boolean
Do we disable connection rejected logging? Default false.boolean
Do we receive all traffic, or only traffic marked with I2PSession.PROTO_STREAMING (6) ? Default true.int
int
What period of inactivity qualifies as "too long"?int
how much data are we willing to accept in our buffer?"reset", "drop", "http", or custom string.int
int
int
int
all of these are @since 0.7.14; no public settersint
What is the largest message to send in the SYN from Alice to Bob?int
What is the largest message we want to send or receive?int
How many times will we try to send a message before giving up?int
int
int
int
int
int
What profile do we want to use for this connection? TODO: Only bulk is supported so far.int
Deprecated.This doesn't appear to be used.boolean
Do we want all packets in both directions to be signed, or can we deal with signatures on the SYN and FIN packets only? There is no property name defined for this, so it's safe to say this is unused and always false.int
How long after sending a packet will we wait before resending?int
getRTO()
int
getRTT()
What to set the round trip time estimate to (in milliseconds)(package private) int
used in TCB @since 0.9.8int
Deprecated.unused as of 0.9.51int
if there are packets we haven't ACKed yet and we don't receive _receiveWindow messages before (_lastSendTime+_sendAckDelay), send an ACK of what we have received so far.int
When we're in slow start, we grow the window size at the rate of 1/(factor).int
This option is mostly handled on the router side, but PacketQueue also needs to know, so that when it overrides, it doesn't exceed the setting.int
This option is mostly handled on the router side, but PacketQueue also needs to know, so that when it overrides, it doesn't exceed the setting.int
How many messages will we send before waiting for an ACK?boolean
boolean
(package private) void
loadFromCache
(int rtt, int rttDev, int wdw) Loads options from TCB cache.boolean
void
setAnswerPings
(boolean yes) void
setCongestionAvoidanceGrowthRateFactor
(int factor) void
setConnectDelay
(int delayMs) void
setDisableRejectLogging
(boolean yes) void
setEnforceProtocol
(boolean yes) void
setInactivityAction
(int action) void
setInactivityTimeout
(int timeout) void
setInboundBufferSize
(int bytes) void
setMaxInitialMessageSize
(int bytes) What is the largest message to send in the SYN from Alice to Bob?void
setMaxMessageSize
(int bytes) void
setMaxResends
(int numSends) void
setMaxWindowSize
(int msgs) void
setProfile
(int profile) void
setProperties
(Properties opts) Note: NOT part of the interface As of 0.9.19, defaults in opts are honored.void
setReceiveWindow
(int numMsgs) void
setRequireFullySigned
(boolean sign) unused, see abovevoid
setResendDelay
(int ms) void
setSendAckDelay
(int delayMs) Unused except here, so expect the default initial delay of DEFAULT_INITIAL_ACK_DELAY unless set by the user to remain constant.void
setSlowStartGrowthRateFactor
(int factor) void
setWindowSize
(int numMsgs) toString()
doesn't include everythingvoid
updateAll
(ConnectionOptions opts) Update everything by copying over from optsvoid
updateRTT
(int measuredValue) Methods inherited from class net.i2p.client.streaming.impl.I2PSocketOptionsImpl
getConnectTimeout, getDouble, getInt, getLocalPort, getMaxBufferSize, getPort, getReadTimeout, getWriteTimeout, init, setConnectTimeout, setLocalPort, setMaxBufferSize, setPort, setReadTimeout, setWriteTimeout
-
Field Details
-
PROFILE_BULK
public static final int PROFILE_BULK- See Also:
-
PROFILE_INTERACTIVE
public static final int PROFILE_INTERACTIVE- See Also:
-
INACTIVITY_ACTION_NOOP
public static final int INACTIVITY_ACTION_NOOPon inactivity timeout, do nothing- See Also:
-
INACTIVITY_ACTION_DISCONNECT
public static final int INACTIVITY_ACTION_DISCONNECTon inactivity timeout, close the connection- See Also:
-
INACTIVITY_ACTION_SEND
public static final int INACTIVITY_ACTION_SENDon inactivity timeout, send a payload message- See Also:
-
PROP_CONNECT_DELAY
- See Also:
-
PROP_PROFILE
- See Also:
-
PROP_MAX_MESSAGE_SIZE
- See Also:
-
PROP_MAX_RESENDS
- See Also:
-
PROP_INITIAL_RESEND_DELAY
- See Also:
-
PROP_INITIAL_ACK_DELAY
- See Also:
-
PROP_INITIAL_WINDOW_SIZE
- See Also:
-
PROP_INITIAL_RECEIVE_WINDOW
unused- See Also:
-
PROP_INACTIVITY_TIMEOUT
- See Also:
-
PROP_INACTIVITY_ACTION
- See Also:
-
PROP_MAX_WINDOW_SIZE
- See Also:
-
PROP_CONGESTION_AVOIDANCE_GROWTH_RATE_FACTOR
- See Also:
-
PROP_SLOW_START_GROWTH_RATE_FACTOR
- See Also:
-
PROP_ANSWER_PINGS
- See Also:
-
PROP_ENABLE_ACCESS_LIST
all of these are @since 0.7.13- See Also:
-
PROP_ENABLE_BLACKLIST
- See Also:
-
PROP_ACCESS_LIST
- See Also:
-
PROP_MAX_CONNS_MIN
all of these are @since 0.7.14- See Also:
-
PROP_MAX_CONNS_HOUR
- See Also:
-
PROP_MAX_CONNS_DAY
- See Also:
-
PROP_MAX_TOTAL_CONNS_MIN
- See Also:
-
PROP_MAX_TOTAL_CONNS_HOUR
- See Also:
-
PROP_MAX_TOTAL_CONNS_DAY
- See Also:
-
PROP_ENFORCE_PROTO
- Since:
- 0.9.1
- See Also:
-
PROP_MAX_STREAMS
how many streams will we allow at once?- Since:
- 0.9.3 moved from I2PSocketManagerFull
- See Also:
-
PROP_DISABLE_REJ_LOG
- Since:
- 0.9.4 default false
- See Also:
-
PROP_LIMIT_ACTION
- Since:
- 0.9.34 reset,drop,http, or custom string, default reset
- See Also:
-
PROP_TAGS_TO_SEND
- Since:
- 0.9.34
- See Also:
-
PROP_TAG_THRESHOLD
- Since:
- 0.9.34
- See Also:
-
INITIAL_WINDOW_SIZE
static final int INITIAL_WINDOW_SIZERFC 5681 sec. 3.1- See Also:
-
DEFAULT_MAX_SENDS
static final int DEFAULT_MAX_SENDS- See Also:
-
DEFAULT_INITIAL_RTT
public static final int DEFAULT_INITIAL_RTT- See Also:
-
MIN_WINDOW_SIZE
static final int MIN_WINDOW_SIZE- See Also:
-
DEFAULT_TAGS_TO_SEND
public static final int DEFAULT_TAGS_TO_SEND- Since:
- 0.9.34
- See Also:
-
DEFAULT_TAG_THRESHOLD
public static final int DEFAULT_TAG_THRESHOLD- Since:
- 0.9.34
- See Also:
-
DEFAULT_MAX_MESSAGE_SIZE
public static final int DEFAULT_MAX_MESSAGE_SIZEOK, here is the calculation on the message size to fit in a single tunnel message without fragmentation. This is based on documentation, the code, and logging, however there are still some parts that could use more research.1024 Tunnel Message - 21 Header (see router/tunnel/BatchedPreprocessor.java) ----- 1003 Tunnel Payload - 39 Unfragmented instructions (see router/tunnel/TrivialPreprocessor.java) ----- 964 Garlic Message - 16 I2NP header - 4 length ----- 944 Garlic Message AES payload padded to 16 bytes - 0 Pad to 16 bytes ----- 944 Garlic Message (assumes no bundled leaseSet or keys) - 32 session tag - 2 tag count - 4 payload size - 32 payload hash - 1 flags - 1 clove count - 33 clove delivery instructions (Tunnel Data Message goes here) - 4 clove ID - 8 clove expiration - 3 clove cert - 3 garlic cert - 4 garlic ID - 8 garlic expiration - 135 total overhead ----- 809 Data Message - 16 I2NP header - 4 length ----- 789 Gzipped I2NP message - 23 Gzip 10 byte header, 5 byte block header, 8 byte trailer (yes we always use gzip, but it probably isn't really compressing, just adding the headers and trailer, since HTTP Server already compresses, and most P2P files aren't compressible. (see client/I2PSessionImpl2.java, util/ReusableGZipOutputStream.java, and the gzip and deflate specs) ----- 766 - 28 Streaming header (22 min) and 6 bytes of options or nacks ----- 738 Streaming message size FOR TWO TUNNEL MESSAGES: 2048 2 Tunnel Messages - 42 2 Headers ----- 2006 Tunnel Payload - 50 Fragmented instructions (43 for first + 7 for second) ----- 1956 Garlic Message - 16 I2NP header - 4 length ----- 1936 Garlic Message AES payload padded to 16 bytes 1936 - 0 Pad to 16 bytes ----- 1936 Garlic Message - 32 session tag - 2 tag count - 4 payload size - 32 payload hash - 1 flags - 1 clove count - 33 clove delivery instructions (Tunnel Data Message goes here) - 4 clove ID - 8 clove expiration - 3 clove cert - 3 garlic cert - 4 garlic ID - 8 garlic expiration - 135 total overhead ----- 1801 Data Message - 16 I2NP header - 4 length ----- 1781 Gzipped I2NP message - 23 Gzip 10 byte header, 5 byte block header, 8 byte trailer ----- 1758 - 28 Streaming header (22 min) and 6 bytes of options or nacks ----- 1730 Streaming message size to fit in 2 tunnel messages Similarly: 3 msgs: 2722 4 msgs: 3714
Before release 0.6.1.14 this was 4096. From release 0.6.1.14 through release 0.6.4, this was 960. It was claimed in the comment that this fit in a single tunnel message (and the checkin comment says the goal was to increase reliability at the expense of throughput), clearly from the math above that was not correct. (Before 0.6.2, the reply leaseSet was bundled with every message, so it didn't even fit in TWO tunnel messages - more like 2 1/3)Now, it's not clear how often we will get the ideal situation (no reply leaseSet bundling, no key bundling, and especially not having a small message ahead of you, which will then cause fragmentation for all subsequent messages until the queue is emptied - BatchedPreprocessor doesn't do reordering, and it isn't clear to me if it could). In particular the initial messages in a new stream are much larger due to the leaseSet and key bundling. But for long-lived streams (like with i2psnark) this should pay dividends. The tunnel.batch* stats should provide some data for test comparisons.
As MTU and MRU are identical and are negotiated to the lowest value for the two ends, you can't do widespread testing of a higher value. Unless we change to allow MTU and MRU to be different, which would be a pain because it would mess up our buffer scheme. Both 738 and 1730 have been tested to verify that the math above is correct. So let's try 1730 for release 0.6.5. This will allow for 738 testing as well, with i2p.streaming.maxMessageSize=738 (in configadvanced.jsp, or in i2ptunnel, or i2psnark, for example).
Not that an isolated single packet is very common, but in this case, 960 was 113.3% total overhead. Compared to 738 (38.8% overhead) and 1730 (18.4%).
- See Also:
-
MIN_MESSAGE_SIZE
public static final int MIN_MESSAGE_SIZE- See Also:
-
DEFAULT_MAX_MESSAGE_SIZE_RATCHET
public static final int DEFAULT_MAX_MESSAGE_SIZE_RATCHETSee analysis in proposal 144- Since:
- 0.9.47
- See Also:
-
-
Constructor Details
-
ConnectionOptions
public ConnectionOptions()Sets max buffer size, connect timeout, read timeout, and write timeout from System properties. Does not set local port or remote port. -
ConnectionOptions
Sets max buffer size, connect timeout, read timeout, and write timeout from properties. Does not set local port or remote port. As of 0.9.19, defaults in opts are honored.- Parameters:
opts
- may be null
-
ConnectionOptions
Initializes from System properties then copies over all options.- Parameters:
opts
- may be null
-
ConnectionOptions
Initializes from System properties then copies over all options.- Parameters:
opts
- may be null
-
-
Method Details
-
updateAll
Update everything by copying over from opts- Parameters:
opts
- non-null- Since:
- 0.9.1
-
setProperties
Note: NOT part of the interface As of 0.9.19, defaults in opts are honored.- Overrides:
setProperties
in classI2PSocketOptionsImpl
- Parameters:
opts
- may be null
-
getConnectDelay
public int getConnectDelay()how long will we wait after instantiating a new con before actually attempting to connect. If this is set to 0, connect ASAP. If it is greater than 0, wait until the output stream is flushed, the buffer fills, or that many milliseconds pass.- Returns:
- how long to wait before actually attempting to connect
-
setConnectDelay
public void setConnectDelay(int delayMs) -
getRequireFullySigned
public boolean getRequireFullySigned()Do we want all packets in both directions to be signed, or can we deal with signatures on the SYN and FIN packets only? There is no property name defined for this, so it's safe to say this is unused and always false.- Returns:
- if we want signatures on all packets.
-
setRequireFullySigned
public void setRequireFullySigned(boolean sign) unused, see above -
getAnswerPings
public boolean getAnswerPings()Do we respond to a ping?- Returns:
- if we do
-
setAnswerPings
public void setAnswerPings(boolean yes) -
getEnforceProtocol
public boolean getEnforceProtocol()Do we receive all traffic, or only traffic marked with I2PSession.PROTO_STREAMING (6) ? Default true. If PROTO is enforced, we cannot communicate with destinations earlier than version 0.7.1 (released March 2009), which is when streaming started sending the PROTO_STREAMING indication. Set to true if you are running multiple protocols on a single Destination.- Returns:
- if we do
- Since:
- 0.9.1
-
setEnforceProtocol
public void setEnforceProtocol(boolean yes) -
getDisableRejectLogging
public boolean getDisableRejectLogging()Do we disable connection rejected logging? Default false.- Returns:
- if we do
- Since:
- 0.9.4
-
setDisableRejectLogging
public void setDisableRejectLogging(boolean yes) -
getWindowSize
public int getWindowSize()How many messages will we send before waiting for an ACK?- Returns:
- Maximum amount of messages that can be in-flight
-
setWindowSize
public void setWindowSize(int numMsgs) -
getReceiveWindow
Deprecated.This doesn't appear to be used.after how many consecutive messages should we ack?- Returns:
- receive window size.
-
setReceiveWindow
public void setReceiveWindow(int numMsgs) -
getRTT
public int getRTT()What to set the round trip time estimate to (in milliseconds)- Returns:
- round trip time estimate in ms
-
getMinRTT
public int getMinRTT()- Returns:
- minimum RTT observed over the life of the connection, greater than zero
- Since:
- 0.9.46
-
getRTO
public int getRTO()- Returns:
- Connection.MIN_RESEND_DELAY to Connection.MAX_RESEND_DELAY
-
getRTTDev
int getRTTDev()used in TCB @since 0.9.8 -
loadFromCache
void loadFromCache(int rtt, int rttDev, int wdw) Loads options from TCB cache. -
doubleRTO
int doubleRTO()Double the RTO (after congestion). See RFC 6298 section 5 item 5.5- Returns:
- new value, Connection.MIN_RESEND_DELAY to Connection.MAX_RESEND_DELAY
- Since:
- 0.9.33
-
getRTTTrend
Deprecated.unused as of 0.9.51If we have 3 consecutive rtt increases, we are trending upwards (1), or if we have 3 consecutive rtt decreases, we are trending downwards (-1), else we're stable.- Returns:
- positive/flat/negative trend in round trip time
-
updateRTT
public void updateRTT(int measuredValue) - Parameters:
measuredValue
- must be positive
-
receivedAck
public boolean receivedAck() -
getResendDelay
public int getResendDelay()How long after sending a packet will we wait before resending?- Returns:
- delay for a retransmission in ms
-
setResendDelay
public void setResendDelay(int ms) -
getSendAckDelay
public int getSendAckDelay()if there are packets we haven't ACKed yet and we don't receive _receiveWindow messages before (_lastSendTime+_sendAckDelay), send an ACK of what we have received so far. Ref: RFC 5681 sec. 4.3, RFC 1122 sec. 4.2.3.3, ticket #2706- Returns:
- ACK delay in ms
-
setSendAckDelay
public void setSendAckDelay(int delayMs) Unused except here, so expect the default initial delay of DEFAULT_INITIAL_ACK_DELAY unless set by the user to remain constant. Changing the default is not recommended. Ref: RFC 5681 sec. 4.3, RFC 1122 sec. 4.2.3.3, ticket #2706 -
getMaxMessageSize
public int getMaxMessageSize()What is the largest message we want to send or receive?- Returns:
- Maximum message size (MTU/MRU)
-
setMaxMessageSize
public void setMaxMessageSize(int bytes) -
getMaxInitialMessageSize
public int getMaxInitialMessageSize()What is the largest message to send in the SYN from Alice to Bob?- Returns:
- the max
- Since:
- 0.9.47
-
setMaxInitialMessageSize
public void setMaxInitialMessageSize(int bytes) What is the largest message to send in the SYN from Alice to Bob?- Since:
- 0.9.47
-
getProfile
public int getProfile()What profile do we want to use for this connection? TODO: Only bulk is supported so far.- Returns:
- the profile of the connection.
-
setProfile
public void setProfile(int profile) -
getMaxResends
public int getMaxResends()How many times will we try to send a message before giving up?- Returns:
- Maximum retrys before failing a sent message.
-
setMaxResends
public void setMaxResends(int numSends) -
getInactivityTimeout
public int getInactivityTimeout()What period of inactivity qualifies as "too long"?- Returns:
- period of inactivity qualifies as "too long"
-
setInactivityTimeout
public void setInactivityTimeout(int timeout) -
getInactivityAction
public int getInactivityAction() -
setInactivityAction
public void setInactivityAction(int action) -
getMaxWindowSize
public int getMaxWindowSize() -
setMaxWindowSize
public void setMaxWindowSize(int msgs) -
getInboundBufferSize
public int getInboundBufferSize()how much data are we willing to accept in our buffer?- Returns:
- size of the buffer used to accept data
-
setInboundBufferSize
public void setInboundBufferSize(int bytes) -
getCongestionAvoidanceGrowthRateFactor
public int getCongestionAvoidanceGrowthRateFactor()When we're in congestion avoidance, we grow the window size at the rate of 1/(windowSize*factor). In standard TCP, window sizes are in bytes, while in I2P, window sizes are in messages, so setting factor=maxMessageSize mimics TCP, but using a smaller factor helps grow a little more rapidly.- Returns:
- window size to grow by to attempt to avoid congestion.
-
setCongestionAvoidanceGrowthRateFactor
public void setCongestionAvoidanceGrowthRateFactor(int factor) -
getSlowStartGrowthRateFactor
public int getSlowStartGrowthRateFactor()When we're in slow start, we grow the window size at the rate of 1/(factor). In standard TCP, window sizes are in bytes, while in I2P, window sizes are in messages, so setting factor=maxMessageSize mimics TCP, but using a smaller factor helps grow a little more rapidly.- Returns:
- slow start window size to grow by to attempt to avoid sending many small packets.
-
setSlowStartGrowthRateFactor
public void setSlowStartGrowthRateFactor(int factor) -
getMaxConnsPerMinute
public int getMaxConnsPerMinute()all of these are @since 0.7.14; no public setters -
getMaxConnsPerHour
public int getMaxConnsPerHour() -
getMaxConnsPerDay
public int getMaxConnsPerDay() -
getMaxTotalConnsPerMinute
public int getMaxTotalConnsPerMinute() -
getMaxTotalConnsPerHour
public int getMaxTotalConnsPerHour() -
getMaxTotalConnsPerDay
public int getMaxTotalConnsPerDay() -
getMaxConns
public int getMaxConns()- Since:
- 0.9.3; no public setter
-
isAccessListEnabled
public boolean isAccessListEnabled() -
isBlacklistEnabled
public boolean isBlacklistEnabled() -
getAccessList
-
getBlacklist
-
getLimitAction
"reset", "drop", "http", or custom string. Default "reset".- Since:
- 0.9.34
-
getTagsToSend
public int getTagsToSend()This option is mostly handled on the router side, but PacketQueue also needs to know, so that when it overrides, it doesn't exceed the setting.- Since:
- 0.9.34
-
getTagThreshold
public int getTagThreshold()This option is mostly handled on the router side, but PacketQueue also needs to know, so that when it overrides, it doesn't exceed the setting.- Since:
- 0.9.34
-
toString
doesn't include everything
-