BodgeMaster
/
NORM-mirror
mirror of https://github.com/USNavalResearchLaboratory/norm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NormSession typos in comments (#12) 

* Fixed default function comments in NormSession

* Fixed typos in NormSession

* Fixed default function comments
pull/85/head
mullerj 2023-03-09 19:37:43 -05:00 committed by GitHub
parent 26944463e2
commit 701360ac48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/dotnet/src/Mil.Navy.Nrl.Norm/NormInstance.cs
View File

@ -134,8 +134,7 @@ namespace Mil.Navy.Nrl.Norm
/// This function retrieves the next available NORM protocol event from the protocol engine.
/// </summary>
/// <remarks>
/// This is a default function which calls GetNextEvent(bool waitForEvent) override
/// with waitForEvent set as true.
/// This is an overload which calls GetNextEvent() with waitForEvent set as true.
/// </remarks>
/// <returns>Returns an instance of NormEvent if NormGetNextEvent() returns true, returns null otherwise.</returns>
public NormEvent? GetNextEvent()

25
src/dotnet/src/Mil.Navy.Nrl.Norm/NormSession.cs
View File

@ -105,8 +105,7 @@ namespace Mil.Navy.Nrl.Norm
/// This function is used to force NORM to use a specific port number for UDP packets sent.
/// </summary>
/// <remarks>
/// This is a default function which calls SetTxPort(int port, bool enableReuse, string? txBindAddress) override
/// with enableReuse set as false and txBindAddress set to null.
/// This is an overload which calls SetTxPort() with enableReuse set as false and txBindAddress set to null.
/// </remarks>
/// <param name="port">The port parameter, specifies which port number to use.</param>
/// <exception cref="IOException">Thrown when NormSetTxPort() returns false, indicating the failure to set tx port.</exception>
@ -134,8 +133,7 @@ namespace Mil.Navy.Nrl.Norm
/// This function limits the NormSession to perform NORM sender functions only.
/// </summary>
/// <remarks>
/// This is a default function which calls etTxOnly(bool txOnly, bool connectToSessionAddress) override
/// with connectToSessionAddress set as false.
/// This is an overload which calls SetTxOnly() with connectToSessionAddress set as false.
/// </remarks>
/// <param name="txOnly">Boolean specifing whether to turn on or off the txOnly operation.</param>
public void SetTxOnly(bool txOnly)
@ -158,8 +156,7 @@ namespace Mil.Navy.Nrl.Norm
/// This function allows the user to control the port reuse and binding behavior for the receive socket.
/// </summary>
/// <remarks>
/// This is a default function which calls SetRxPortReuse(bool enable, string? rxBindAddress, string? senderAddress, int senderPort)
/// with rxBindAddress set to null, senderAddress set to null, and senderPort set to 0.
/// This is an overload that calls SetRxPortReuse() with rxBindAddress set to null, senderAddress set to null, and senderPort set to 0.
/// </remarks>
/// <param name="enable">When the enable parameter is set to true, reuse of the NormSession port number by multiple NORM instances or sessions is enabled.</param>
public void SetRxPortReuse(bool enable)
@ -181,8 +178,7 @@ namespace Mil.Navy.Nrl.Norm
}
/// <remarks>
/// This is a default function which calls SetEcnSupport(bool ecnEnable, bool ignoreLoss, bool tolerateLoss) override
/// with tolerateLoss set as false.
/// This is an overload which calls SetEcnSupport() with tolerateLoss set as false.
/// </remarks>
/// <param name="ecnEnable">Enables NORM ECN (congestion control) support.</param>
/// <param name="ignoreLoss">With "ecnEnable", use ECN-only, ignoring packet loss.</param>
@ -321,8 +317,7 @@ namespace Mil.Navy.Nrl.Norm
/// but congestion control operation can be dynamically enabled/disabled during the course of sender operation.
/// </summary>
/// <remarks>
/// This is the default function which calls SetCongestionControl(bool enable, bool adjustRate) override
/// with adjustRate set to true.
/// This is an overload which calls SetCongestionControl() with adjustRate set to true.
/// </remarks>
/// <param name="enable">Specifies whether to enable or disable the NORM sender congestion control operation.</param>
public void SetCongestionControl(bool enable)
@ -464,7 +459,7 @@ namespace Mil.Navy.Nrl.Norm
/// "repair window" as needed for some applications. While relative paths with respect to the "current working directory"
/// may be used, it is recommended that full paths be used when possible.</param>
/// <param name="info">The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object.</param>
/// <param name="infoOffset">Indicates the strart of the message. Anything before it will not be sent.
/// <param name="infoOffset">Indicates the start of the message. Anything before it will not be sent.
/// Note: to send full message infoOffset should be set to 0.</param>
/// <param name="infoLength">The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object.</param>
/// <returns>A NormFile is returned which the application may use in other NORM API calls as needed.</returns>
@ -496,7 +491,7 @@ namespace Mil.Navy.Nrl.Norm
/// This is an overload which will call DataEnqueue() with info set to null, infoOffset set to 0, and infoLength set to 0.
/// </remarks>
/// <param name="dataBuffer">The dataBuffer is a byte array containing the message to be transmitted.</param>
/// <param name="dataOffset">Indicates the strart of the message. Anything before it will not be sent.
/// <param name="dataOffset">Indicates the start of the message. Anything before it will not be sent.
/// Note: to send full message dataOffset should be set to 0.</param>
/// <param name="dataLength">Size of the message.</param>
/// <returns>A NormData is returned which the application may use in other NORM API calls as needed.</returns>
@ -510,11 +505,11 @@ namespace Mil.Navy.Nrl.Norm
/// This function enqueues a segment of application memory space for transmission.
/// </summary>
/// <param name="dataBuffer">The dataBuffer is a byte array containing the message to be transmitted.</param>
/// <param name="dataOffset">Indicates the strart of the message. Anything before it will not be sent.
/// <param name="dataOffset">Indicates the start of the message. Anything before it will not be sent.
/// Note: to send full message dataOffset should be set to 0.</param>
/// <param name="dataLength">Size of the message.</param>
/// <param name="info">The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object.</param>
/// <param name="infoOffset">Indicates the strart of the message.</param>
/// <param name="infoOffset">Indicates the start of the message.</param>
/// <param name="infoLength">The optional info and infoLength parameters are used to associate NORM_INFO content with the sent transport object.</param>
/// <returns>A NormData is returned which the application may use in other NORM API calls as needed.</returns>
/// <exception cref="IOException">Thrown when NormDataEnqueue() returns NORM_OBJECT_INVALID, indicating the failure to enqueue data.</exception>
@ -572,7 +567,7 @@ namespace Mil.Navy.Nrl.Norm
/// <param name="bufferSize"> The bufferSize parameter controls the size of the stream's "repair window"
/// which limits how far back the sender will "rewind" to satisfy receiver repair requests.</param>
/// <param name="info">Alloted memory space for transmitted information.</param>
/// <param name="infoOffset">Indicates the strart of the message. Anything before it will not be sent.
/// <param name="infoOffset">Indicates the start of the message. Anything before it will not be sent.
/// Note: to send full message infoOffset should be set to 0.</param>
/// <param name="infoLength">Size of the message.</param>
/// <returns>A NormStream is returned which the application may use in other NORM API calls as needed.</returns>

6
src/dotnet/src/Mil.Navy.Nrl.Norm/NormStream.cs
View File

@ -83,8 +83,7 @@
/// This function causes an immediate "flush" of the transmit stream.
/// </summary>
/// <remarks>
/// This is a default function which calls Flush(bool eom, NormFlushMode flushMode) override
/// with eom set as false and flushMode set to NORM_FLUSH_PASSIVE
/// This is an overload which calls Flush() with eom set as false and flushMode set to NORM_FLUSH_PASSIVE
/// </remarks>
public void Flush()
{
@ -107,8 +106,7 @@
/// has been explicitly retained by a call to NormObjectRetain().
/// </summary>
/// <remarks>
/// This is a default function which calls Close(bool graceful) override
/// with graceful set as false.
/// This is an overload which calls Close() with graceful set as false.
/// </remarks>
public void Close()
{