Warroom/warroom-system/Library/Mirle.Component.SocketDriver/Document/Mirle.Component.SocketDriver.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Mirle.Component.SocketDriver</name>
    </assembly>
    <members>
        <member name="T:Mirle.Component.SocketDirver.FrameBuilder.IFrameBuilder">
            <summary>
            框架建立介面
            </summary>
        </member>
        <member name="M:Mirle.Component.SocketDirver.FrameBuilder.IFrameBuilder.EncodeFrame(System.Byte[])">
            <summary>
            加密
            </summary>
            <param name="payload">封包訊息</param>
            <returns>加密封包訊息</returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.FrameBuilder.IFrameBuilder.TryDecodeFrame(System.Byte[],System.Int32@,System.Byte[]@)">
            <summary>
            解密
            </summary>
            <param name="buffer">暫存訊息</param>
            <param name="receiveCount">接收數量</param>
            <param name="payload">解密封包訊息</param>
            <returns>True/False</returns>
        </member>
        <member name="T:Mirle.Component.SocketDirver.FrameBuilder.ProtobufferFrameBulder">
            <summary>
            Google Protobuffer 訊息加解密類別
            </summary>
        </member>
        <member name="M:Mirle.Component.SocketDirver.FrameBuilder.ProtobufferFrameBulder.EncodeFrame(System.Byte[])">
            <inheritdoc/>
        </member>
        <member name="M:Mirle.Component.SocketDirver.FrameBuilder.ProtobufferFrameBulder.TryDecodeFrame(System.Byte[],System.Int32@,System.Byte[]@)">
            <inheritdoc/>
        </member>
        <member name="T:Mirle.Component.SocketDirver.SocketWrapper">
            <summary>
            Class for Socket wrapper
            </summary>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.#ctor(NLog.Logger)">
            <summary>
            Constructure
            </summary>
            <param name="log">Log</param>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.#ctor(NLog.Logger,Mirle.Component.SocketDirver.FrameBuilder.IFrameBuilder)">
            <summary>
            Constructure
            </summary>
            <param name="log">Log</param>
            <param name="frameBuilder">Interface for message frame builder</param>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.ConnectMode">
            <summary>
            Socket connect mode
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.TCPClients">
            <summary>
            TCP client list
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.ClientCount">
            <summary>
            TCP client count threshold
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.Address">
            <summary>
            Socket server/client address
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.Port">
            <summary>
            Socket server/client port
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.IsConnected">
            <summary>
            Is socket server/client connected
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.KeepConnectedTimeout">
            <summary>
            Time out of keep connected
            </summary>
        </member>
        <member name="P:Mirle.Component.SocketDirver.SocketWrapper.OnReceived">
            <summary>
            Subject event of receive
            </summary>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.OnReceivedList(System.Int32)">
            <summary>
            Subject event of receive
            </summary>
            <param name="index">Index of client receive subject list</param>
            <returns></returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.OpenAsync">
            <summary>
            Open socket connect
            </summary>
            <returns>Completed task successfully</returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.CloseAsync">
            <summary>
            Close socket connect
            </summary>
            <returns>Completed task successfully</returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.Send(System.Byte[],System.Net.EndPoint)">
            <summary>
            Send message
            </summary>
            <param name="payload">Message payload</param>
            <param name="endPoint">Remote end point of address</param>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.SendAsync(System.Byte[],System.Net.EndPoint)">
            <summary>
            Send message
            </summary>
            <param name="payload">Message payload</param>
            <param name="endPoint">Client remote end point address</param>
            <returns>Completed task successfully</returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.ProcessConnectStateByWatiForConnecting">
            <summary>
            Process socket connect state by wait for connecting
            </summary>
            <returns>Completed task successfully</returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.ProcessConnectStateByConnected">
            <summary>
            Process socket connect state by connected
            </summary>
            <returns>Completed task successfully</returns>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.ProcessConnectStateByStop">
            <summary>
            Process socket connect state by stop
            </summary>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.Dispose(System.Boolean)">
            <inheritdoc/>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.Finalize">
            <inheritdoc/>
        </member>
        <member name="M:Mirle.Component.SocketDirver.SocketWrapper.Dispose">
            <inheritdoc/>
        </member>
        <member name="T:Mirle.Component.SocketDirver.ConnectMode">
            <summary>
            Connect mode
            </summary>
        </member>
        <member name="F:Mirle.Component.SocketDirver.ConnectMode.Server">
            <summary>
            Server
            </summary>
        </member>
        <member name="F:Mirle.Component.SocketDirver.ConnectMode.Client">
            <summary>
            Client
            </summary>
        </member>
        <member name="T:Mirle.Component.SocketDirver.ConnectState">
            <summary>
            連線狀態
            </summary>
        </member>
        <member name="F:Mirle.Component.SocketDirver.ConnectState.Initial">
            <summary>
            Initial
            </summary>
        </member>
        <member name="F:Mirle.Component.SocketDirver.ConnectState.WaitForConnecting">
            <summary>
            Wait for connecting
            </summary>
        </member>
        <member name="F:Mirle.Component.SocketDirver.ConnectState.Connected">
            <summary>
            Connected
            </summary>
        </member>
        <member name="F:Mirle.Component.SocketDirver.ConnectState.Stop">
            <summary>
            Stop
            </summary>
        </member>
    </members>
</doc>