Skip to content

Commit 08fa084

Browse files
committed
Update comments
1 parent f26b99a commit 08fa084

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

src/core/federation.ts

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,6 @@ function isANodeJSCodedError(e: Error): e is NodeJSCodedError {
292292
*/
293293
export class NetworkSender extends Reactor {
294294
/**
295-
* This function is for NetworkSender reactors.
296295
* The last reaction of a NetworkSender reactor is 'portAbsentReactor'.
297296
* @returns portAbsentReactor of this NetworkSender reactor
298297
*/
@@ -302,17 +301,15 @@ export class NetworkSender extends Reactor {
302301
}
303302

304303
/**
305-
* A network reactor is a reactor handling network actions (NetworkReceiver and NetworkSender).
304+
* A network receiver is a reactor handling a network input.
306305
*/
307306
export class NetworkReceiver<T> extends Reactor {
308307
/*
309-
* A FederatePortAction instance of this NetworkReactor. The action is only registered when this
310-
* reactor is a network receiver. Otherwise, it is remained undefined.
308+
* A FederatePortAction instance of this NetworkReceiver.
311309
*/
312310
private networkInputAction: FederatePortAction<T> | undefined = undefined;
313311

314-
// The port ID of networkInputAction. It is defined if this NetworkReactor is
315-
// a network receiver.
312+
// The port ID of networkInputAction.
316313
private readonly portID: number;
317314

318315
constructor(parent: Reactor, portID: number) {
@@ -338,8 +335,7 @@ export class NetworkReceiver<T> extends Reactor {
338335
}
339336

340337
/**
341-
* Handle a timed message being received from the RTI.
342-
* This function is for NetworkReceiver reactors.
338+
* Handle a message being received from the RTI.
343339
* @param portID The destination port ID of the message.
344340
* @param value The payload of the message.
345341
*/
@@ -361,7 +357,6 @@ export class NetworkReceiver<T> extends Reactor {
361357

362358
/**
363359
* Handle a timed message being received from the RTI.
364-
* This function is for NetworkReceiver reactors.
365360
* @param portID The destination port ID of the message.
366361
* @param value The payload of the message.
367362
*/

0 commit comments

Comments
 (0)