Opération simple de lecture et d'écriture sur une socket. More...

#include "cogitant/cs/ccxx.h"

Inheritance diagram for cogitantcs::OperationCSIO_TCP:

Public Member Functions
	OperationCSIO_TCP (ost::tpport_t port=4246)
	Constructeur pour utilisation en serveur. More...

	OperationCSIO_TCP (std::string const &host, ost::tpport_t port=4246)
	Constructeur pour utilisation en client. More...

	~OperationCSIO_TCP ()
	Destructeur. More...

void	open ()
	Ouverture d'une connexion client. More...

void	close ()
	Fermeture d'une connexion client. More...

void	listen ()
	Démarrage de l'écoute (mode serveur). More...

void	stop ()
	Arrêt de l'écoute (mode serveur). More...

void	receive (cogitant::XmlDocument &doc, iSession &ids)
	Lecture d'un document XML dans le flux d'échange. More...

void	send (cogitant::XmlDocument const &doc, iSession ids=0)
	Envoi d'un document XML dans le flux d'échange. More...

void	send (std::list< std::string > const &txt, iSession ids=0)
	Envoi de texte dans le flux d'échange. More...

Public Member Functions inherited from cogitantcs::OperationCSIO
	OperationCSIO (bool rh=false)
	Constructeur par défaut. More...

virtual	~OperationCSIO ()
	Destructeur. More...

void	setParamRequiresHeader (bool rh)
	Sortie ou pas d'une entête `Content-type`. More...

Error	check ()
	Méthode non utilisée dans cette classe. More...

void	run ()
	Méthode non utilisée dans cette classe. More...

virtual Status	status () const
	État. More...

Public Member Functions inherited from cogitant::OperationBase
void	stop ()
	Stopper l'opération dès que possible. More...

bool	isStopped () const
	Est-ce que l'opération a été stoppée. More...

	OperationBase ()
	Constructeur. More...

	OperationBase (OperationBase const &o)
	Constructeur par recopie. More...

	~OperationBase ()
	Destructeur. More...

Public Member Functions inherited from cogitant::ObservableObject
	ObservableObject ()
	Constructeur. More...

	ObservableObject (ObservableObject const &o)
	Constructeur par recopie. More...

	~ObservableObject ()
	Destructeur. More...

ObserverSet const &	observers () const
	Accès à l'ensemble des observateurs. More...

bool	hasObservers () const
	Existence d'observateurs. More...

bool	hasObservers (ObserverMessage::Type mt) const
	Existence d'observateurs qui écoutent le type de message passé. More...

void	attachObserver (Observer *obs)
	Ajoute un nouvel observateur à l'objet. More...

void	detachObserver (Observer *obs)
	Supprime le lien entre l'observateur et l'objet. More...

void	notifyObservers (ObserverMessage const *msg)
	Envoie le message de modification à tous les observateurs. More...

Public Member Functions inherited from cogitant::CogitantObject
	CogitantObject ()
	Constructeur. More...

	CogitantObject (CogitantObject const &o)
	Constructeur par recopie. More...

virtual	~CogitantObject ()
	Destructeur. More...

PropertySet *	properties ()
	Accès à l'ensemble des propriétés. More...

virtual std::string	toString () const
	Transformation en chaîne de caractères. More...

std::string	className () const
	Nom de la classe. More...

PropertySet const *	properties () const
	Accès en lecture seule à l'ensemble des propriétés. More...

bool	hasProperties () const
	Existence de propriétés. More...

CogitantObject &	operator= (CogitantObject const &ob)
	Affectation. More...

Additional Inherited Members
Public Types inherited from cogitantcs::OperationCSIO
enum	Status { CLOSED, OPENED, LISTENING }
	État de l'opération. More...

Public Types inherited from cogitant::OperationBase
typedef unsigned int	Error
	Résultat de la vérification des arguments d'une opération. More...

Static Public Attributes inherited from cogitant::OperationBase
static const Error	CHECKOK
	Pas d'erreur. More...

static const Error	ARGUMENTS
	Certains paramètres de l'opération n'ont pas été fixés. More...

static const Error	UNUSED
	Symbole d'erreur inutilisé. More...

Protected Member Functions inherited from cogitant::ObservableObject
virtual ObserverSet *	allocObservers () const
	Fonction créant l'instance d'une sous classe de ObserverSet pour la représentation de l'ensemble des observateurs de l'objet. More...

ObserverSet &	observers ()
	Accès à l'ensemble des observateurs. More...

Protected Member Functions inherited from cogitant::CogitantObject
virtual PropertySet *	allocProperties () const
	Fonction créant l'instance d'une sous classe de PropertySet pour la représentation des propriétés de l'objet. More...

Protected Attributes inherited from cogitantcs::OperationCSIO
bool	m_requiresheader
	Si `true`, un entête du type `Content-type` doit être sorti sur le flux avant chaque send().

Status	m_status
	État.

Protected Attributes inherited from cogitant::OperationBase
bool	m_stop
	Arrêt de l'exécution de l'opération demandé. More...

Detailed Description

Opération simple de lecture et d'écriture sur une socket.

Cette opération n'accepte pas plusieurs connextions simultanées

Warning: Requiert l'utilisation de la bibliothèque CommonC++.

Constructor & Destructor Documentation

◆ OperationCSIO_TCP() [1/2]

cogitantcs::OperationCSIO_TCP::OperationCSIO_TCP ( ost::tpport_t port = 4246 )

Constructeur pour utilisation en serveur.

Parameters

port	Numéro de port d'attente de connexions.

◆ OperationCSIO_TCP() [2/2]

cogitantcs::OperationCSIO_TCP::OperationCSIO_TCP	(	std::string const &	host,
		ost::tpport_t	port = `4246`
	)

Constructeur pour utilisation en client.

Parameters

host	Nom d'hote du serveur.
port	Numéro du port du serveur.

◆ ~OperationCSIO_TCP()

cogitantcs::OperationCSIO_TCP::~OperationCSIO_TCP ( )

Destructeur.

Member Function Documentation

◆ close()

void cogitantcs::OperationCSIO_TCP::close ( )

virtual

Fermeture d'une connexion client.

La liaison TCP est coupée.

Reimplemented from cogitantcs::OperationCSIO.

◆ listen()

void cogitantcs::OperationCSIO_TCP::listen ( )

virtual

Démarrage de l'écoute (mode serveur).

Reimplemented from cogitantcs::OperationCSIO.

◆ open()

void cogitantcs::OperationCSIO_TCP::open ( )

virtual

Ouverture d'une connexion client.

La connexion est demandée vers le serveur / port précisés au constructeur.

Reimplemented from cogitantcs::OperationCSIO.

◆ receive()

void cogitantcs::OperationCSIO_TCP::receive	(	cogitant::XmlDocument &	doc,
		iSession &	ids
	)

virtual

Lecture d'un document XML dans le flux d'échange.

Parameters

doc	(R) document lu.
ids	(R) un identificateur représentant l'origine du document lu. Côté client, ce paramètre n'a aucun intérêt, côté serveur "mono-connexion", non plus. Par contre, dans le cas d'un serveur pouvant gérer plusieurs connexions simultanées, ce paramètre contient en retour l'identificateur de la connexion à l'origine du document XML recu.

Implements cogitantcs::OperationCSIO.

◆ send() [1/2]

void cogitantcs::OperationCSIO_TCP::send	(	cogitant::XmlDocument const &	doc,
		iSession	ids = `0`
	)

virtual

Envoi d'un document XML dans le flux d'échange.

Parameters

doc	document à envoyer.
ids	identificateur de la session dans le cas d'un serveur multi-connexion. Ce paramètre n'est pas utilisé chez le client, ni dans le cas d'un serveur gérant une seule connexion.

Implements cogitantcs::OperationCSIO.

◆ send() [2/2]

void cogitantcs::OperationCSIO_TCP::send	(	std::list< std::string > const &	txt,
		iSession	ids = `0`
	)

virtual

Envoi de texte dans le flux d'échange.

Parameters

txt	texte à envoyer.
ids	identificateur de la session dans le cas d'un serveur multi-connexion. Ce paramètre n'est pas utilisé chez le client, ni dans le cas d'un serveur gérant une seule connexion.

Implements cogitantcs::OperationCSIO.

◆ stop()

void cogitantcs::OperationCSIO_TCP::stop ( )

virtual

Arrêt de l'écoute (mode serveur).

Reimplemented from cogitantcs::OperationCSIO.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OperationCSIO_TCP() [1/2]

◆ OperationCSIO_TCP() [2/2]

◆ ~OperationCSIO_TCP()

Member Function Documentation

◆ close()

◆ listen()

◆ open()

◆ receive()

◆ send() [1/2]

◆ send() [2/2]

◆ stop()