WebClient documentation

Area

Cache	CommandsManager
Dispatcher	EventFactory
MessageBus	QueriesManager
Server

Cache

Cache

AddNewService(service)

Add a new Network.NetTools.Service to the service list

Name	Description
service	Network.NetTools.Service A Network.NetTools.Service

AddTree(e)

Add a tree to the tree list

Name	Description
e	Network.Events.Event An Network.Events.Event

Returns

An Network.Events.HttpEventAnswer

AddUser(e)

Add an Network.NetTools.User to the user list

Name	Description
e	Network.Events.Event An Network.Events.Event

Returns

An Network.Events.HttpEventAnswer

GetAreaTreeList

Get the AREA tree list

Returns

The AREA tree list

GetAreaTreeList(e)

Get the AREA Tree list

Name	Description
e	Network.Events.Event An Network.Events.Event

Returns

An Network.Events.HttpEventAnswer

GetServiceList

Get the service list

Returns

A list of Network.NetTools.Service

GetServiceList(e)

Get the service list

Name	Description
e	Network.Events.Event An Network.Events.Event

Returns

An Network.Events.HttpEventAnswer

GetUserByMail(mail)

Get an Network.NetTools.User by its mail

Name	Description
mail	System.String The Network.NetTools.User's mail

Returns

An Network.NetTools.User

GetUserList

Get the User list

Returns

A list of Network.NetTools.User

GetUserList(e)

Get the User List

Name	Description
e	Network.Events.Event An Network.Events.Event

Returns

An Network.Events.HttpEventAnswer

RemoveService(serviceName)

Remove a Network.NetTools.Service by its name

Name	Description
serviceName	System.String The Network.NetTools.Service's name

UpdateServicesList

Update the services list

CommandsManager

Defines a manager used to handle HTTP commands

AutomaticEventCallback(e)

Callback for Network.Events.Event received from the core app

Name	Description
e	Network.Events.Event

Returns

EvtFactory

EventFactory used to manage the Network.Events.Events

ExtEventCallback(e)

Callback for Network.Events.Event received from an external client

Name	Description
e	Network.Events.Event

Returns

ProcessEvent(e)

Main entry point to process an Network.Events.Event in the server

Name	Description
e	Network.Events.Event The event to be processed

Returns

An Network.Events.HttpEventAnswer

ServiceEventCallback(e)

Callback for Network.Events.Event received from a service

Name	Description
e	Network.Events.Event

Returns

Dispatcher

Handle new events and route them to

Constructor

Default constructor for Dispatcher

Routes

Getter and Setter for the Dispatcher routes

Trigger(e)

EntryPoint of the Dispatcher which handle and route events

Name	Description
e	Network.Events.Event Network.Events.Event to be routed

Returns

A Network.Events.HttpEventAnswer object which define the answer of the server for the event

EventFactory

Defines a manager for the creation and the destructions of Network.Events.Event.#ctor(Network.Events.HttpEventSource,Network.Events.HttpEventType,Network.NetTools.User,System.Object)

MessageBus

Defines a bus designed to transfer Event between services and a server.

Constructor

Main constructor for the message bus

Add(e)

Add an event into the message bus

Name	Description
e	Network.Events.Event The event to be added

Returns

A success answer

eventList

The list of event to be processed

Finalize

Destructor for the message bus

IsServiceInList(list, serviceName)

Check if the service is in the services list

Name	Description
list	System.Collections.Generic.List{Network.NetTools.Service} A list of Network.NetTools.Service
serviceName	System.String The Network.NetTools.Service's name

Returns

MessageBusCallback(obj)

Callback used when a service want to communicate with the server

Name	Description
obj	Network.NetTools.Packet The Network.NetTools.Packet sent by the service

Returns

RegisterReactionForUser(user, serviceName, reactionName)

Register a reaction for the user

Name	Description
user	Network.NetTools.User An Network.NetTools.User
serviceName	System.String The Network.NetTools.Service's name
reactionName	System.String The reaction name

RemoveUSelessServicesFromCache

Remove useless services from the MessageBus's cache

UpdateRegistrationForServices

Update registration for the services

QueriesManager

Defines the class which will manage the get queries

Constructor

QueriesManager

ProcessEvent(e)

ProcessEvent

Name	Description
e	Network.Events.Event The event to be added

Returns

An Network.Events.HttpEventAnswer

Routes

Routes

Server

Define micro-services Server main features

Constructor

Main constructor for Server

AddMonitorEventMessage(name, source, content)

Add an event message to the monitor

Name	Description
name	System.String The name
source	System.Int32 A source
content	System.String The content of message

Bus

Getter and Setter for MessageBus member variable of Server

Commands

Getter and Setter for CommandsManager member variable of Server

Dispatcher

Getter and Setter for Server.Dispatcher member variable of Server

EventFactory

Getter and Setter for Server.EventFactory member variable of Server

Finalize

Default destructor for the server

instance

Singleton instance for Server

Instance

Getter for the singleton instance of the Server

MonitorCallback(data)

Callback used when a monitor send a request to the server

Name	Description
data	Network.NetTools.Packet The Network.NetTools.Packet data

Queries

Getter and Setter for QueriesManager member variable of Server

SetLog

Bind the standard output of the server to a specific log file