Constructor
new ClientParametersBuilder()
Creates a client parameters builder.
Extends
Classes
Members
agentRegistry :AgentClassRegistry
Type:
- Overrides:
autoStart :boolean
Type:
- boolean
- Overrides:
compressed :boolean
Type:
- boolean
- Overrides:
crcCheck :boolean
Type:
- boolean
- Overrides:
encryptionKey :Uint8Array|null
Type:
- Uint8Array | null
- Overrides:
maxReceiveBufferSize :number
Type:
- number
- Overrides:
Methods
build() → {ClientParameters}
Builds a ClientParameters instance using the
current builder configuration.
- Overrides:
Returns:
Configured client parameters.
- Type
- ClientParameters
registerAgent(jsClass, javaFqcn) → {this}
Registers a JavaScript Agent class with its
corresponding Java fully qualified class name.
Used to reconstruct the correct JavaScript class
when receiving serialized Agents from KDC-Java.
Parameters:
| Name | Type | Description |
|---|---|---|
jsClass |
function | JavaScript Agent constructor. |
javaFqcn |
string | Fully qualified Java class name. |
- Overrides:
Returns:
This builder for method chaining.
- Type
- this
registerAgents(agentMap) → {this}
Registers multiple Agent classes.
Each Map entry associates a JavaScript constructor
with its corresponding Java fully qualified class name.
Parameters:
| Name | Type | Description |
|---|---|---|
agentMap |
Map.<function(), string> | Map of JavaScript constructors to Java class names. |
- Overrides:
Throws:
-
If agentMap is not a Map.
- Type
- Error
Returns:
This builder for method chaining.
- Type
- this
withCompressed(value) → {this}
Enables or disables GZIP compression.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether compression is enabled. |
- Overrides:
Returns:
This builder for method chaining.
- Type
- this
withCrcCheck(value) → {this}
Enables or disables CRC checking for Agent packets.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | Whether CRC checking is enabled. |
- Overrides:
Returns:
This builder for method chaining.
- Type
- this
withEncryptionKey(value) → {this}
Configures the encryption key used for AES-GCM.
A null value disables encryption.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Uint8Array | null | Raw AES encryption key, or null. |
- Overrides:
Returns:
This builder for method chaining.
- Type
- this
withMaxReceiveBufferSize(value) → {this}
Sets the maximum permitted receive buffer size.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number | Maximum receive buffer size in bytes. |
- Overrides:
Throws:
-
If value is not a positive integer.
- Type
- Error
Returns:
This builder for method chaining.
- Type
- this