A network driver for an external system. More...

#include <ExternalSystem.hpp>

Collaboration diagram for samchon::protocol::ExternalSystem:

[legend]

Public Member Functions
	ExternalSystem ()
	Default Constructor. More...

virtual void	construct (std::shared_ptr< library::XML >) override
	Construct data of the Entity from an XML object. More...

virtual void	start ()=0
	Start interaction. More...

virtual auto	key () const -> std::string override
	Get a key that can identify the Entity uniquely. More...

virtual void	replyData (std::shared_ptr< Invoke >) override
	Handling replied message from an external system. More...

virtual auto	TAG () const -> std::string override
	A tag name when represented by XML. More...

virtual auto	CHILD_TAG () const -> std::string override
	A tag name of children. More...

virtual auto	toXML () const -> std::shared_ptr< library::XML > override
	Get an XML object represents the EntityGroup. More...

Public Member Functions inherited from samchon::protocol::EntityGroup< _Container, _ETy, T >
	EntityGroup ()
	Default Constructor. More...

auto	has (const std::string &key) const -> bool
	Indicates whether a container has an object having the specified identifier. More...

auto	get (const std::string &key) -> value_type &
	Access the element by specified identifier(key). More...

auto	get (const std::string &key) const -> const value_type &
	Access the const element by specified identifier(key). More...

Public Member Functions inherited from samchon::protocol::Entity
	Entity ()
	Default Constructor. More...

Public Member Functions inherited from samchon::protocol::IEntityGroup
	IEntityGroup ()
	Default Constructor. More...

Public Member Functions inherited from samchon::protocol::IClient
	IClient ()
	Default Constructor. More...

virtual void	listen ()
	Listens message from a related system. More...

virtual void	sendData (std::shared_ptr< Invoke >)
	Sends message to a related system. More...

Public Member Functions inherited from samchon::protocol::IProtocol
	IProtocol ()
	Default Constructor. More...

Protected Attributes
std::string	name
	A name can identify an external system. More...

std::string	ip
	An ip address of an external system. More...

int	port
	A port number of an external system. More...

Protected Attributes inherited from samchon::protocol::IClient
Socket *	socket
	Socket for network I/O. More...

std::mutex *	sendMtx
	A mutex for sending message. More...

Additional Inherited Members
Protected Member Functions inherited from samchon::protocol::EntityGroup< _Container, _ETy, T >
virtual auto	createChild (std::shared_ptr< library::XML >) -> entity_type *=0
	Factory method of a child Entity. More...

Protected Member Functions inherited from samchon::protocol::IClient
virtual auto	BUFFER_SIZE () const -> size_t
	Buffer size of network I/O. More...

virtual void	_replyData (std::shared_ptr< Invoke >)
	A method for pre-processing replied Invoke message. More...

Detailed Description

A network driver for an external system.

ExternalSystem is a boundary class interacting with an external system by network communication. Also, ExternalSystem is an abstract class that a network role, which one is server and which one is client, is not determined yet.

The ExternalSystem has ExternalSystemRole(s) groupped methods, handling Invoke message interacting with the external system, by subject or unit of a moudle. The ExternalSystemRole is categorized in a 'control'.

Example Sources

example::interaction

Note

The ExternalSystem class takes a role of interaction with external system in network level. However, within a framework of Samchon Framework, a boundary class like the ExternalSystem is not such important. You can find some evidence in a relationship between ExternalSystemArray, ExternalSystem and ExternalSystemRole.

Of course, the ExternalSystemRole is belonged to an ExternalSystem. However, if you access an ExternalSystemRole from an ExternalSystemArray directly, not passing by a belonged ExternalSystem, and send an Invoke message even you're not knowing which ExternalSystem is related in, it's called "Proxy pattern".

Like the explanation of "Proxy pattern", you can utilize an ExternalSystemRole as a proxy of an ExternalSystem. With the pattern, you can only concentrate on ExternalSystemRole itself, what to do with Invoke message, irrespective of the ExternalSystemRole is belonged to which ExternalSystem.

See also: samchon::protocol

Author: Jeongho Nam http://samchon.org

Definition at line 49 of file ExternalSystem.hpp.

Constructor & Destructor Documentation

ExternalSystem::ExternalSystem ( )

Default Constructor.

Definition at line 15 of file ExternalSystem.cpp.

Member Function Documentation

void ExternalSystem::construct ( std::shared_ptr< library::XML > xml )

overridevirtual

Construct data of the Entity from an XML object.

Constructs the EntityGroup's own member variables only from the input XML object.

Do not consider about constructing children Entity objects' data in EntityGroup::construct(). Those children Entity objects' data will constructed by their own construct() method. Even insertion of XML objects representing children are done by abstract method of EntityGroup::toXML().

Constructs only data of EntityGroup's own.

[Inherited]: Construct data of the Entity from an XML object.

Overrides the construct() method and fetch data of member variables from the XML.

By recommended guidance, data representing member variables are contained in properties of the put XML object.

Parameters

xml	An xml used to construct data of entity

Reimplemented from samchon::protocol::EntityGroup< _Container, _ETy, T >.

Reimplemented in samchon::protocol::master::DistributedSystem, samchon::protocol::master::ParallelSystem, samchon::protocol::ExternalServer, samchon::protocol::master::DistributedServer, and samchon::protocol::master::ParallelServer.

Definition at line 20 of file ExternalSystem.cpp.

References samchon::protocol::EntityGroup< _Container, _ETy, T >::construct(), ip, name, and port.

Referenced by samchon::protocol::master::ParallelClientArrayMediator::construct(), samchon::protocol::ExternalServer::construct(), samchon::protocol::master::ParallelSystemArrayMediator::construct(), samchon::protocol::master::ParallelSystem::construct(), and samchon::protocol::master::DistributedSystem::construct().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void samchon::protocol::ExternalSystem::start ( )

pure virtual

Start interaction.

An abstract method starting interaction with an external system.

If an external systems are a server, starts connection and listening Inovoke message, else clients, just starts listening only. You also can addict your own procudures of starting the driver, but if you directly override method of abstract ExternalSystem, be careful about virtual inheritance.

Implemented in samchon::protocol::ExternalServer, and samchon::protocol::ExternalClient.

Referenced by samchon::protocol::ExternalServerArray::start(), and samchon::protocol::master::ParallelSystemArrayMediator::start().

Here is the caller graph for this function:

auto ExternalSystem::key ( ) const -> std::string

overridevirtual

Get a key that can identify the Entity uniquely.

If identifier of the Entity is not atomic value, returns a string represents the composite identifier. If identifier of the Entity is not string, converts the identifier to string and returns the string.

Returns: An identifier

Reimplemented from samchon::protocol::Entity.

Definition at line 33 of file ExternalSystem.cpp.

References name.

void ExternalSystem::replyData ( std::shared_ptr< Invoke > )

overridevirtual

Handling replied message from an external system.

If there's a related ExternalSystemRole, shifts responsibility to the ExternalSystemRole.

Parameters

invoke Replied Invoke message

Reimplemented from samchon::protocol::IProtocol.

Reimplemented in samchon::protocol::master::DistributedSystem, samchon::example::interaction::SlaveDriver, and samchon::protocol::master::DistributedSlaveSystemMediator.

Definition at line 41 of file ExternalSystem.cpp.

Referenced by samchon::protocol::slave::SlaveSystem::_replyData(), samchon::protocol::master::ParallelSystem::construct(), and samchon::protocol::slave::ParallelSystem::ParallelSystem().

Here is the caller graph for this function:

auto ExternalSystem::TAG ( ) const -> std::string

overridevirtual

A tag name when represented by XML.

Returns: A tag name

Implements samchon::protocol::Entity.

Reimplemented in samchon::protocol::master::ParallelSlaveSystemMediator, and samchon::protocol::master::DistributedSlaveSystemMediator.

Definition at line 53 of file ExternalSystem.cpp.

auto ExternalSystem::CHILD_TAG ( ) const -> std::string

overridevirtual

A tag name of children.

< TAG>
<CHILD_TAG />
<CHILD_TAG />
</TAG>

Implements samchon::protocol::IEntityGroup.

Definition at line 57 of file ExternalSystem.cpp.

auto ExternalSystem::toXML ( ) const -> std::shared_ptr<library::XML>

overridevirtual

Get an XML object represents the EntityGroup.

Archives the EntityGroup's own member variables only to the returned XML object.

Do not consider about archiving children Entity objects' data in EntityGroup::toXML(). Those children Entity objects will converted to XML object by their own toXML() method. The insertion of XML objects representing children are done by abstract method of EntityGroup::toXML().

Archives only data of EntityGroup's own.

[Inherited]: Get an XML object represents the Entity.

Returns an XML object that can represents the Entity containing member variables into properties.

A member variable (not object, but atomic value like number, string or date) is categorized as a property within the framework of entity side. Thus, when overriding a toXML() method and archiving member variables to an XML object to return, puts each variable to be a property belongs to only an XML object.

Don't archive the member variable of atomic value to XML::value causing enormouse creation of XML objects to number of member variables. An Entity must be represented by only an XML instance (tag).

Standard Usage	Non-standard usage abusing value
<memberList> <member id='jhnam88' name='Jeongho+Nam' birthdate='1988-03-11' /> <member id='master' name='Administartor' birthdate='2011-07-28' /> </memberList>	<member> <id>jhnam88</id> <name>Jeongho+Nam</name> <birthdate>1988-03-11</birthdate> </member>