Show / Hide Table of Contents

    Interface IConnection

    Interface for all types of connections.

    Namespace: Fibula.Communications.Contracts.Abstractions
    Assembly: Fibula.Communications.Contracts.dll
    Syntax
    public interface IConnection

    Properties

    | Improve this Doc View Source

    IsOrphaned

    Gets a value indicating whether the connection is an orphan.

    Declaration
    bool IsOrphaned { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    | Improve this Doc View Source

    Close()

    Closes this connection.

    Declaration
    void Close()
    | Improve this Doc View Source

    Read()

    Reads the next message in this connection.

    Declaration
    void Read()
    | Improve this Doc View Source

    Send(IEnumerable<IOutboundPacket>)

    Sends the packets supplied through this connection.

    Declaration
    void Send(IEnumerable<IOutboundPacket> packetsToSend)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<IOutboundPacket> packetsToSend

    The packets to send.

    Events

    | Improve this Doc View Source

    Closed

    Event fired when this connection has been closed.

    Declaration
    event ConnectionClosedDelegate Closed
    Event Type
    Type Description
    ConnectionClosedDelegate
    | Improve this Doc View Source

    PacketProcessed

    Event fired right after this connection has proccessed an IIncomingPacket by any subscriber of the PacketReady event.

    Declaration
    event ConnectionPacketProccessedDelegate PacketProcessed
    Event Type
    Type Description
    ConnectionPacketProccessedDelegate
    | Improve this Doc View Source

    PacketReady

    Event fired when a IIncomingPacket picked up by this connection is ready to be processed.

    Declaration
    event ConnectionPacketReadyDelegate PacketReady
    Event Type
    Type Description
    ConnectionPacketReadyDelegate

    Extension Methods

    ObjectExtensions.YieldSingleItem<T>(T)
    ObjectExtensions.GetPropertyValue(Object, String)
    Validate.ThrowIfNull(Object, String)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2018-2020 | The Fibula Project
    Generated using DocFX | Jose L. Nuñez de Caceres et al.