Class NetSocketTcpScenarioSender

Implementation of a ScenarioSender using .Net sockets over TCP

Inheritance

object

AScenarioSender

NetSocketTcpScenarioSender

Implements

INetSocketTcp

IDisposable

Inherited Members

AScenarioSender.Scenarios

AScenarioSender.RegisterToScenario(Scenario)

AScenarioSender.UnregisterFromScenario(string)

AScenarioSender.InternalScenarioChange(object, EventArgs)

AScenarioSender.InternalTransitionFired(object, TransitionFiredEventArgs)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Scenarios.Network

Assembly: Xareus.Scenarios.Network.dll

Syntax

public class NetSocketTcpScenarioSender : AScenarioSender, INetSocketTcp, IDisposable

Fields

clientsRegistrations

Declaration

protected Dictionary<string, List<NetSocketTcpScenarioSender.ClientUpdateRegistration>> clientsRegistrations

Field Value

Type	Description
Dictionary<string, List<NetSocketTcpScenarioSender.ClientUpdateRegistration>>

clientsRegistrationsForNewScenarios

Declaration

protected List<NetSocketTcpScenarioSender.ClientNewScenarioRegistration> clientsRegistrationsForNewScenarios

Field Value

Type	Description
List<NetSocketTcpScenarioSender.ClientNewScenarioRegistration>

serverSocket

Declaration

protected TcpListener serverSocket

Field Value

Type	Description
TcpListener

Properties

IsListening

Is the server currently listening (i.e. waiting for receivers)

Declaration

public bool IsListening { get; }

Property Value

Type	Description
bool

IsReceiving

Declaration

public bool IsReceiving { get; set; }

Property Value

Type	Description
bool

OnConnected

Event fired when a receiver connected

Declaration

public EventHandler OnConnected { get; set; }

Property Value

Type	Description
EventHandler

OnDisconnected

Event fired when a receiver disconnects

Declaration

public EventHandler OnDisconnected { get; set; }

Property Value

Type	Description
EventHandler

Methods

AcceptCallback(IAsyncResult)

This is the method called when a new receiver connected

Declaration

protected virtual void AcceptCallback(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar

ConvertToParameter<T>(T, IContext)

Convert an object to a parameter using the given external context

Declaration

protected virtual Parameter ConvertToParameter<T>(T eventContext, IContext externalContext)

Parameters

Type	Name	Description
T	eventContext
IContext	externalContext

Returns

Type	Description
Parameter

Type Parameters

Name	Description
T

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~NetSocketTcpScenarioSender()

Declaration

protected ~NetSocketTcpScenarioSender()

HandleClientRequest(TcpClient, string)

Handle client requests

Declaration

protected virtual void HandleClientRequest(TcpClient client, string data)

Parameters

Type	Name	Description
TcpClient	client
string	data

PostRegisterToScenario(Scenario)

PostRegisterToScenario(Scenario)

Declaration

protected override void PostRegisterToScenario(Scenario scenario)

Parameters

Type	Name	Description
Scenario	scenario

Overrides

AScenarioSender.PostRegisterToScenario(Scenario)

ScenarioChange(string, ScenarioState)

ScenarioChange(string, ScenarioState) When a scenario changes, warn all receiver that registered previously

Declaration

protected override void ScenarioChange(string scenarioInstanceId, ScenarioState scenarioState)

Parameters

Type	Name	Description
string	scenarioInstanceId
ScenarioState	scenarioState

Overrides

AScenarioSender.ScenarioChange(string, ScenarioState)

SendExternalScenarios(Scenario, TcpClient)

Send all external scenarios of the current scenario. No need for recursion, we check all the sequences.

Declaration

protected virtual void SendExternalScenarios(Scenario scenarioToSend, TcpClient client)

Parameters

Type	Name	Description
Scenario	scenarioToSend
TcpClient	client

StartListenTask(CancellationTokenSource)

This is the task where the Sender wait for new receivers to connect

Declaration

protected void StartListenTask(CancellationTokenSource tokenSource = null)

Parameters

Type	Name	Description
CancellationTokenSource	tokenSource

StartServer(int)

Start the server (listening for receivers) on the given port

Declaration

public void StartServer(int port = 7777)

Parameters

Type	Name	Description
int	port

StopServer()

Stop the server

Declaration

public void StopServer()

TransitionFired(string, Transition, IContext, IContext, IContext, IContext)

TransitionFired(string, Transition, IContext, IContext, IContext, IContext) When a transition is fired, warn all receiver that registered previously

Declaration

protected override void TransitionFired(string scenarioInstanceId, Transition transition, IContext externalContext, IContext scenarioContext, IContext sequenceContext, IContext eventContext)

Parameters

Type	Name	Description
string	scenarioInstanceId
Transition	transition	The transition
IContext	externalContext
IContext	scenarioContext
IContext	sequenceContext
IContext	eventContext

Overrides

AScenarioSender.TransitionFired(string, Transition, IContext, IContext, IContext, IContext)

Events

OnConnectedEvent

Event fired when a receiver connected

Declaration

public event EventHandler OnConnectedEvent

Event Type

Type	Description
EventHandler

OnDisconnectedEvent

Event fired when a receiver disconnects

Declaration

public event EventHandler OnDisconnectedEvent

Event Type

Type	Description
EventHandler

Implements

INetSocketTcp

IDisposable