Base Framework
Public Member Functions | List of all members
LocalConnection Class Reference

Local connection. More...

#include <base/rmi/LocalConnection.h>

Inherits OrbConnection.

Public Member Functions

 LocalConnection (ProtectedPointer< Orb > orb, const String &identifier)
 
String getUrn () const noexcept
 
String getEndPoint () const noexcept
 
OrbReference getReference (const String &identifier) noexcept
 
MemorySize push (const uint8 *buffer, MemorySize size)
 
void pushEnd ()
 
MemorySize pull (uint8 *buffer, MemorySize size)
 
void reconnect ()
 
 ~LocalConnection () noexcept
 
- Public Member Functions inherited from OrbConnection
 OrbConnection (ProtectedPointer< Orb > _orb, Reference< OrbBufferPool > _pool) noexcept
 
void push (OrbBuffer *buffer) noexcept
 
virtual ~OrbConnection () noexcept
 
- Public Member Functions inherited from Polymorphic
 Polymorphic () noexcept
 
virtual ~Polymorphic () noexcept
 
- Public Member Functions inherited from ReferenceCountedObject
 ReferenceCountedObject () noexcept
 
 ReferenceCountedObject (const ReferenceCountedObject &copy) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&move) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &copy) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&move) noexcept
 
MemorySize getNumberOfReferences_INTERNAL () const noexcept
 
virtual bool useGarbageCollector () const noexcept
 
- Public Member Functions inherited from DynamicObject
 DynamicObject () noexcept
 
bool isValidObject () const noexcept
 
virtual ~DynamicObject () noexcept(false)
 
 _COM_AZURE_DEV__BASE__OVERRIDE_ALLOC ()
 
- Public Member Functions inherited from PushInterface
virtual void flush ()
 
virtual bool pushBegin (uint64 totalSize)
 

Additional Inherited Members

- Protected Attributes inherited from OrbConnection
ProtectedPointer< Orborb
 
Reference< OrbBufferPoolpool
 

Detailed Description

Local connection.

Local connection.

See also
LocalConnectionFactory
Version
1.0

Constructor & Destructor Documentation

◆ LocalConnection()

LocalConnection::LocalConnection ( ProtectedPointer< Orb orb,
const String identifier 
)

Initializes the conenction.

Parameters
identifierThe end point identifier.

◆ ~LocalConnection()

LocalConnection::~LocalConnection ( )
noexcept

Destroys the local connection.

Member Function Documentation

◆ getEndPoint()

String LocalConnection::getEndPoint ( ) const
virtualnoexcept

Returns the identifier of the end point (e.g. "local:///").

Implements OrbConnection.

◆ getReference()

OrbReference LocalConnection::getReference ( const String identifier)
virtualnoexcept

Returns the reference for the specified connection local identifier.

Parameters
identifierIdentifier (e.g. "/MyObject").

Implements OrbConnection.

◆ getUrn()

String LocalConnection::getUrn ( ) const
virtualnoexcept

Returns the global identifier of the scheme (e.g. "urn:rmi:orb:scheme:local").

Implements OrbConnection.

◆ pull()

MemorySize LocalConnection::pull ( uint8 *  buffer,
MemorySize  size 
)
virtual

Pulls data from the stream. EndOfFile is raised if atEnd() would return true.

Parameters
bufferThe buffer to receive the data.
sizeThe size of the buffer.
Returns
The number of bytes pulled.

Implements PullInterface.

◆ push()

MemorySize LocalConnection::push ( const uint8 *  buffer,
MemorySize  size 
)
virtual

Pushes data onto the stream. This method may return 0 if the internal buffer is full. EndOfFile is raised if the end has been reached.

Parameters
bufferThe data to be pushed onto the stream.
sizeThe size of the buffer.
Returns
The number of bytes pushed.

Implements PushInterface.

◆ pushEnd()

void LocalConnection::pushEnd ( )
virtual

This method should be invoked when all data has been pushed onto the stream. Do not invoke push() or pushEnd() hereafter.

Reimplemented from PushInterface.

◆ reconnect()

void LocalConnection::reconnect ( )

Reestablishes the connection.