Public Member Functions | Private Member Functions | List of all members
IoConnectionWrapperInterface Class Reference
IO

#include <ioconnection_wrapper.h>

Inheritance diagram for IoConnectionWrapperInterface:
Inheritance graph
[legend]

Detailed Description

An io connection wrapper wraps an underlying connection. There's the default implementation IoConnectionWrapperClass which forwards all calls to the underlying connection.

Public Member Functions

MAXON_METHOD Result< void > Init (const Url &url, const IoConnectionRef &wrappedConnection, Bool readOnly, Bool forwardStreams)
 
MAXON_METHOD const IoConnectionRef & GetWrappedConnection () const
 

Private Member Functions

 MAXON_INTERFACE (IoConnectionWrapperInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.ioconnectionwrapper", MAXON_IMPLEMENTATION_MODULE("net.maxon.kernel"))
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( IoConnectionWrapperInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.ioconnectionwrapper"  ,
MAXON_IMPLEMENTATION_MODULE("net.maxon.kernel")   
)
private

◆ Init()

MAXON_METHOD Result<void> Init ( const Url &  url,
const IoConnectionRef &  wrappedConnection,
Bool  readOnly,
Bool  forwardStreams 
)

Initializes this connection wrapper.

Parameters
[in]urlThe Url for the connection.
[in]wrappedConnectionThe underlying connection.
[in]readOnlyTrue if this connection shall be read-only, i.e., all methods which would write to the underlying connection shall fail with an error.
[in]forwardStreamsTrue if stream-related methods shall be forwarded to the underlying connection. If false, you have to implement the necessary methods yourself.

◆ GetWrappedConnection()

MAXON_METHOD const IoConnectionRef& GetWrappedConnection ( ) const

Returns the underlying connection which has been set by Init().

Returns
Underlying connection.