FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OMEconnection Class Reference

establishes and maintains a connection with a FARGOS/VISTA Object Management Environment. More...

#include <OMEapi.h>

Public Member Functions

 OMEconnection (const OMEoid &objId, const OMEstring &destination, const OMEtype &authentication)
 
 ~OMEconnection ()
 
int establishConnection ()
 
int sendMessage (const OMEtype &dest, int *errRet=nullptr)
 
int receiveMessage (OMEtype &result, int *errRet=nullptr)
 
int getPeerObject (OMEtype &obj)
 
OMEioDescriptorgetDescriptor () const
 
int getHandle () const
 

Private Member Functions

void freeEncryptionResources ()
 
int sendString (const OMEstring &data, int *errRet=nullptr)
 
OMEstringreceiveString (int *errRet=nullptr)
 
OMEstringencodeData (const OMEtype &messData)
 
OMEtypedecodeData (const OMEstring &data)
 
int negotiateKey ()
 

Private Attributes

OMEioDescriptordescriptor
 
OMEstring destination
 
OMEstring secret
 
OMEtype authenticationData
 
OMEoidthisObject
 
OMEtype remoteOID
 
OMEtype peerOID
 
int encodeVersion
 
int encryptCipherID
 
int encryptKeyID
 
int decryptCipherID
 
int decryptKeyID
 
OMEstring userInfo
 
OMEstring VISTAdomainName
 

Detailed Description

establishes and maintains a connection with a FARGOS/VISTA Object Management Environment.

All session key negotiation, encoding, compression and encryption is performed by an OMEconnection object. This class is normally never accessed directly; instead, the class OMEapi provides the standard high-level interface.

Constructor & Destructor Documentation

◆ OMEconnection()

OMEconnection::OMEconnection ( const OMEoid objId,
const OMEstring destination,
const OMEtype authentication 
)

◆ ~OMEconnection()

OMEconnection::~OMEconnection ( )

Member Function Documentation

◆ decodeData()

OMEtype * OMEconnection::decodeData ( const OMEstring data)
private

Referenced by receiveMessage().

◆ encodeData()

OMEstring * OMEconnection::encodeData ( const OMEtype messData)
private

◆ establishConnection()

int OMEconnection::establishConnection ( )

◆ freeEncryptionResources()

void OMEconnection::freeEncryptionResources ( )
private

◆ getDescriptor()

OMEioDescriptor* OMEconnection::getDescriptor ( ) const
inline

References descriptor.

Referenced by OMEapi::getDescriptor().

◆ getHandle()

int OMEconnection::getHandle ( ) const
inline

References descriptor, and OMEioDescriptor::ioHandle.

Referenced by OMEapi::getHandle().

◆ getPeerObject()

int OMEconnection::getPeerObject ( OMEtype obj)
inline

References peerOID.

Referenced by OMEapi::getPeerObject().

◆ negotiateKey()

◆ receiveMessage()

int OMEconnection::receiveMessage ( OMEtype result,
int *  errRet = nullptr 
)

◆ receiveString()

OMEstring * OMEconnection::receiveString ( int *  errRet = nullptr)
private

◆ sendMessage()

int OMEconnection::sendMessage ( const OMEtype dest,
int *  errRet = nullptr 
)

◆ sendString()

int OMEconnection::sendString ( const OMEstring data,
int *  errRet = nullptr 
)
private

Member Data Documentation

◆ authenticationData

OMEtype OMEconnection::authenticationData
private

◆ decryptCipherID

int OMEconnection::decryptCipherID
private

◆ decryptKeyID

int OMEconnection::decryptKeyID
private

◆ descriptor

◆ destination

OMEstring OMEconnection::destination
private

Referenced by establishConnection().

◆ encodeVersion

int OMEconnection::encodeVersion
private

Referenced by encodeData(), and OMEconnection().

◆ encryptCipherID

int OMEconnection::encryptCipherID
private

◆ encryptKeyID

int OMEconnection::encryptKeyID
private

◆ peerOID

OMEtype OMEconnection::peerOID
private

Referenced by getPeerObject().

◆ remoteOID

OMEtype OMEconnection::remoteOID
private

◆ secret

OMEstring OMEconnection::secret
private

Referenced by negotiateKey(), and OMEconnection().

◆ thisObject

OMEoid* OMEconnection::thisObject
private

Referenced by OMEconnection(), and ~OMEconnection().

◆ userInfo

OMEstring OMEconnection::userInfo
private

Referenced by OMEconnection().

◆ VISTAdomainName

OMEstring OMEconnection::VISTAdomainName
private

Referenced by negotiateKey(), and OMEconnection().


The documentation for this class was generated from the following files:
Generated: Tue Jul 28 2020 16:03:27
Support Information