Package io.github.mahmoudimus.quic.connection

Class RandomConnectionIdGenerator

java.lang.Object

io.github.mahmoudimus.quic.connection.RandomConnectionIdGenerator

All Implemented Interfaces:

ConnectionIdGenerator

public final class RandomConnectionIdGenerator
extends Object
implements ConnectionIdGenerator

Generates random connection IDs of a fixed length, 8 bytes by default.

Threads. Safe to share if the Random is (a SecureRandom is).

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LENGTH	The default ID length, 8 bytes.

Constructor Summary

Constructors

Constructor	Description
RandomConnectionIdGenerator()	A generator of 8-byte IDs from a new SecureRandom, which never expire.
RandomConnectionIdGenerator(int length, long lifetime, Random random)	A generator.

Method Summary

Modifier and Type	Method	Description
int	cidLength()	The length of the IDs, which the endpoint needs to parse short headers.
long	cidLifetime()	How long an ID lives before it is retired and replaced.
ConnectionId	generateCid()	A new connection ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mahmoudimus.quic.connection.ConnectionIdGenerator

validate

Field Details

DEFAULT_LENGTH

public static final int DEFAULT_LENGTH

The default ID length, 8 bytes.

See Also:

• Constant Field Values

Constructor Details

RandomConnectionIdGenerator

public RandomConnectionIdGenerator()

A generator of 8-byte IDs from a new SecureRandom, which never expire.

RandomConnectionIdGenerator

public RandomConnectionIdGenerator(int length,
 long lifetime,
 Random random)

A generator.

Parameters:

length - the ID length, 0 to 20

lifetime - how long IDs live in nanoseconds, or -1 for forever

random - the source of randomness; a SecureRandom outside tests

Throws:

IllegalArgumentException - if the length is out of range

Method Details

generateCid

public ConnectionId generateCid()

Description copied from interface: ConnectionIdGenerator

A new connection ID.

Specified by:

generateCid in interface ConnectionIdGenerator

Returns:

an ID of ConnectionIdGenerator.cidLength() bytes

cidLength

public int cidLength()

Description copied from interface: ConnectionIdGenerator

The length of the IDs, which the endpoint needs to parse short headers.

Specified by:

cidLength in interface ConnectionIdGenerator

Returns:

0 to 20 bytes

cidLifetime

public long cidLifetime()

Description copied from interface: ConnectionIdGenerator

How long an ID lives before it is retired and replaced.

Specified by:

cidLifetime in interface ConnectionIdGenerator

Returns:

nanoseconds, or -1 for forever