fix of xml code comment docs

master
xieguigang 5 years ago
parent 890e86eff6
commit fbf6cebcde

@ -83,10 +83,10 @@ Namespace Rpc.BindingProtocols.TaskBuilders
''' <returns>
''' The queued task.
''' </returns>
''' <paramname="proc">
''' <param name="proc">
''' procedure number
''' </param>
''' <paramname="args">
''' <param name="args">
''' instance of arguments of request
''' </param>
''' <typeparamname="TReq">

@ -62,9 +62,9 @@ Namespace Rpc.BindingProtocols.TaskBuilders
''' number 111 (SUNRPC) on either of these protocols.
''' http://tools.ietf.org/html/rfc1833#section-3.2
''' </summary>
''' <paramname="conn">instance of connector</param>
''' <paramname="token">cancellation token</param>
''' <paramname="attachedToParent">attache created task to parent task</param>
''' <param name="conn">instance of connector</param>
''' <param name="token">cancellation token</param>
''' <param name="attachedToParent">attache created task to parent task</param>
Public Sub New(ByVal conn As IRpcClient, ByVal token As CancellationToken, ByVal attachedToParent As Boolean)
MyBase.New(conn, token, attachedToParent)
End Sub

@ -63,9 +63,9 @@ Namespace Rpc.BindingProtocols.TaskBuilders
''' For TCP/IP and UDP/IP, for example, it is port number 111. Each transport has such an assigned, well-known address.
''' http://tools.ietf.org/html/rfc1833#section-2.2.1
''' </summary>
''' <paramname="conn">instance of connector</param>
''' <paramname="token">cancellation token</param>
''' <paramname="attachedToParent">attache created task to parent task</param>
''' <param name="conn">instance of connector</param>
''' <param name="token">cancellation token</param>
''' <param name="attachedToParent">attache created task to parent task</param>
Public Sub New(ByVal conn As IRpcClient, ByVal token As CancellationToken, ByVal attachedToParent As Boolean)
MyBase.New(conn, token, attachedToParent)
End Sub

@ -64,9 +64,9 @@ Namespace Rpc.BindingProtocols.TaskBuilders
''' For TCP/IP and UDP/IP, for example, it is port number 111. Each transport has such an assigned, well-known address.
''' http://tools.ietf.org/html/rfc1833#section-2.2.1
''' </summary>
''' <paramname="conn">instance of connector</param>
''' <paramname="token">cancellation token</param>
''' <paramname="attachedToParent">attache created task to parent task</param>
''' <param name="conn">instance of connector</param>
''' <param name="token">cancellation token</param>
''' <param name="attachedToParent">attache created task to parent task</param>
Public Sub New(ByVal conn As IRpcClient, ByVal token As CancellationToken, ByVal attachedToParent As Boolean)
MyBase.New(conn, token, attachedToParent)
End Sub

@ -52,7 +52,7 @@ Namespace Rpc
''' <summary>
''' Authenticate error
''' </summary>
''' <paramname="replyBody"></param>
''' <param name="replyBody"></param>
Public Sub New(ByVal replyBody As reply_body)
MyBase.New(replyBody)
End Sub
@ -60,8 +60,8 @@ Namespace Rpc
''' <summary>
''' Authenticate error
''' </summary>
''' <paramname="replyBody"></param>
''' <paramname="message"></param>
''' <param name="replyBody"></param>
''' <param name="message"></param>
Public Sub New(ByVal replyBody As reply_body, ByVal message As String)
MyBase.New(replyBody, message)
End Sub
@ -69,9 +69,9 @@ Namespace Rpc
''' <summary>
''' Authenticate error
''' </summary>
''' <paramname="replyBody"></param>
''' <paramname="message"></param>
''' <paramname="innerEx"></param>
''' <param name="replyBody"></param>
''' <param name="message"></param>
''' <param name="innerEx"></param>
Public Sub New(ByVal replyBody As reply_body, ByVal message As String, ByVal innerEx As Exception)
MyBase.New(replyBody, message, innerEx)
End Sub

@ -68,7 +68,7 @@ Namespace Rpc
''' <summary>
''' Error received in response RPC message
''' </summary>
''' <paramname="replyBody"></param>
''' <param name="replyBody"></param>
Public Sub New(ByVal replyBody As reply_body)
Me.ReplyBody = replyBody
End Sub
@ -76,8 +76,8 @@ Namespace Rpc
''' <summary>
''' Error received in response RPC message
''' </summary>
''' <paramname="replyBody"></param>
''' <paramname="message"></param>
''' <param name="replyBody"></param>
''' <param name="message"></param>
Public Sub New(ByVal replyBody As reply_body, ByVal message As String)
MyBase.New(message)
Me.ReplyBody = replyBody
@ -86,9 +86,9 @@ Namespace Rpc
''' <summary>
''' Error received in response RPC message
''' </summary>
''' <paramname="replyBody"></param>
''' <paramname="message"></param>
''' <paramname="innerEx"></param>
''' <param name="replyBody"></param>
''' <param name="message"></param>
''' <param name="innerEx"></param>
Public Sub New(ByVal replyBody As reply_body, ByVal message As String, ByVal innerEx As Exception)
MyBase.New(message, innerEx)
Me.ReplyBody = replyBody

@ -57,7 +57,7 @@ Namespace Rpc
''' <summary>
''' Error associated with work on RPC protocol
''' </summary>
''' <paramname="message"></param>
''' <param name="message"></param>
Public Sub New(ByVal message As String)
MyBase.New(message)
End Sub
@ -65,8 +65,8 @@ Namespace Rpc
''' <summary>
''' Error associated with work on RPC protocol
''' </summary>
''' <paramname="message"></param>
''' <paramname="innerEx"></param>
''' <param name="message"></param>
''' <param name="innerEx"></param>
Public Sub New(ByVal message As String, ByVal innerEx As Exception)
MyBase.New(message, innerEx)
End Sub

@ -57,10 +57,10 @@ Namespace Rpc
''' <returns>
''' the runned task
''' </returns>
''' <paramname="callBody">call body structure</param>
''' <paramname="reqArgs">instance of request arguments</param>
''' <paramname="options">task creation options</param>
''' <paramname="token">cancellation token</param>
''' <param name="callBody">call body structure</param>
''' <param name="reqArgs">instance of request arguments</param>
''' <param name="options">task creation options</param>
''' <param name="token">cancellation token</param>
''' <typeparamname="TReq">type of request</typeparam>
''' <typeparamname="TResp">type of response</typeparam>
Function CreateTask(Of TReq, TResp)(ByVal callBody As call_body, ByVal reqArgs As TReq, ByVal options As TaskCreationOptions, ByVal token As CancellationToken) As Task(Of TResp)

@ -77,8 +77,8 @@ Namespace Rpc
''' <summary>
''' Create RPC client from TCP protocol.
''' </summary>
''' <paramname="ep">server address</param>
''' <paramname="blockSize">block size</param>
''' <param name="ep">server address</param>
''' <param name="blockSize">block size</param>
Public Shared Function FromTcp(ByVal ep As IPEndPoint, ByVal Optional blockSize As Integer = 1024 * 4) As RpcClient
Log.Debug("Create RPC client for TCP server:{0}", ep)
Return New RpcClient(Function() New TcpSession(ep, blockSize))
@ -87,7 +87,7 @@ Namespace Rpc
''' <summary>
''' Create RPC client from UDP protocol.
''' </summary>
''' <paramname="ep">server address</param>
''' <param name="ep">server address</param>
Public Shared Function FromUdp(ByVal ep As IPEndPoint) As RpcClient
Log.Debug("Create RPC client for UDP server:{0}", ep)
Return New RpcClient(Function() New UdpSession(ep))

@ -95,7 +95,7 @@ Namespace Rpc.TcpStreaming
''' <summary>
''' read an array of length 'count' bytes
''' </summary>
''' <paramname="count">required bytes</param>
''' <param name="count">required bytes</param>
''' <returns></returns>
Public Function Read(ByVal count As UInteger) As Byte() Implements IByteReader.Read
Dim buffer = New Byte(count - 1) {}

@ -64,7 +64,7 @@ Namespace Rpc.TcpStreaming
''' <summary>
''' generator TCP messages with record mark
''' </summary>
''' <paramname="maxBlock">maximum block size in the TCP message</param>
''' <param name="maxBlock">maximum block size in the TCP message</param>
Public Sub New(ByVal maxBlock As Integer)
_maxBlock = maxBlock
_pos = 4
@ -75,7 +75,7 @@ Namespace Rpc.TcpStreaming
''' <summary>
''' write array of bytes
''' </summary>
''' <paramname="buffer"></param>
''' <param name="buffer"></param>
Public Sub Write(ByVal buffer As Byte()) Implements IByteWriter.Write
Dim offset As Long = 0
@ -98,7 +98,7 @@ Namespace Rpc.TcpStreaming
''' <summary>
''' write byte
''' </summary>
''' <paramname="b"></param>
''' <param name="b"></param>
Public Sub Write(ByVal b As Byte) Implements IByteWriter.Write
_currentBlock(_pos) = b
_pos += 1

@ -66,7 +66,7 @@ Namespace Rpc
''' <summary>
''' create writer configured for RPC protocol
''' </summary>
''' <paramname="writer"></param>
''' <param name="writer"></param>
''' <returns></returns>
Public Function CreateWriter(ByVal writer As IByteWriter) As Writer
Return _wb.Create(writer)
@ -75,7 +75,7 @@ Namespace Rpc
''' <summary>
''' create reader configured for RPC protocol
''' </summary>
''' <paramname="reader"></param>
''' <param name="reader"></param>
''' <returns></returns>
Public Function CreateReader(ByVal reader As IByteReader) As Reader
Return _rb.Create(reader)
@ -91,7 +91,7 @@ Namespace Rpc
''' <summary>
''' convert byte array to text
''' </summary>
''' <paramname="buffer"></param>
''' <param name="buffer"></param>
''' <returns></returns>
<Extension()>
Public Function ToDisplay(ByVal buffer As Byte()) As String
@ -119,7 +119,7 @@ Namespace Rpc
''' <summary>
''' returns the description of the RPC message
''' </summary>
''' <paramname="msg"></param>
''' <param name="msg"></param>
''' <returns></returns>
Public Sub ReplyMessageValidate(ByVal msg As rpc_msg)
Try

@ -62,7 +62,7 @@ Namespace Rpc.UdpDatagrams
''' <summary>
''' parser of RPC message received from UDP protocol
''' </summary>
''' <paramname="bytes">UDP datagram</param>
''' <param name="bytes">UDP datagram</param>
Public Sub New(ByVal bytes As Byte())
_pos = 0
_leftToRead = bytes.Length
@ -72,7 +72,7 @@ Namespace Rpc.UdpDatagrams
''' <summary>
''' read an array of length 'count' bytes
''' </summary>
''' <paramname="count">required bytes</param>
''' <param name="count">required bytes</param>
''' <returns></returns>
Public Function Read(ByVal count As UInteger) As Byte() Implements IByteReader.Read
If _leftToRead < count Then Throw UnexpectedEnd()

@ -75,7 +75,7 @@ Namespace Rpc.UdpDatagrams
''' <summary>
''' write array of bytes
''' </summary>
''' <paramname="buffer"></param>
''' <param name="buffer"></param>
Public Sub Write(ByVal buffer As Byte()) Implements IByteWriter.Write
_totalSize += buffer.Length
If _totalSize > _max Then Throw SizeIsExceeded()
@ -100,7 +100,7 @@ Namespace Rpc.UdpDatagrams
''' <summary>
''' write byte
''' </summary>
''' <paramname="b"></param>
''' <param name="b"></param>
Public Sub Write(ByVal b As Byte) Implements IByteWriter.Write
_totalSize += 1
If _totalSize > _max Then Throw SizeIsExceeded()

Loading…
Cancel
Save