internal::ConnectionProxy Class Reference

Host's proxy object between connection points. More...

#include <ConnectionProxy.h>

Inheritance diagram for internal::ConnectionProxy:

Collaboration diagram for internal::ConnectionProxy:

Public Member Functions
	ConnectionProxy (Steinberg::Vst::IConnectionPoint *source)
virtual	~ConnectionProxy ()
Steinberg::tresult PLUGIN_API	connect (IConnectionPoint *other) override
Steinberg::tresult PLUGIN_API	disconnect (IConnectionPoint *other) override
Steinberg::tresult PLUGIN_API	notify (Steinberg::Vst::IMessage *message) override

Public Attributes
	DECLARE_FUNKNOWN_METHODS

Private Attributes
std::thread::id	mThreadId
Steinberg::IPtr< Steinberg::Vst::IConnectionPoint >	mSource
Steinberg::IPtr< Steinberg::Vst::IConnectionPoint >	mTarget

Detailed Description

Host's proxy object between connection points.

Though it's not necessary to place proxy, it's recommended to do so. Right now the only "useful" task performed by this proxy is ensuring that messages are sent on the same thread on which proxy object itself was created

Definition at line 24 of file ConnectionProxy.h.

Constructor & Destructor Documentation

ConnectionProxy()

internal::ConnectionProxy::ConnectionProxy

(

Steinberg::Vst::IConnectionPoint *

source

)

Definition at line 15 of file ConnectionProxy.cpp.

   : mSource(source)
{
   mThreadId = std::this_thread::get_id();
   FUNKNOWN_CTOR;
}

References mThreadId.

~ConnectionProxy()

internal::ConnectionProxy::~ConnectionProxy ( )

virtual

Definition at line 21 of file ConnectionProxy.cpp.

{
   FUNKNOWN_DTOR;
}

Member Function Documentation

connect()

Steinberg::tresult internal::ConnectionProxy::connect ( IConnectionPoint *  other )

override

Definition at line 26 of file ConnectionProxy.cpp.

{
   if(other == nullptr)
      return Steinberg::kInvalidArgument;
   if(mTarget.get() != nullptr)
      return Steinberg::kResultFalse;
 
   //Looks a bit awkward, but the source can send messages to
   //the target during connection
   mTarget = other;
   auto result = mSource->connect(this);
   if(result != Steinberg::kResultOk)
      mTarget = nullptr;
   return result;
}

disconnect()

Steinberg::tresult internal::ConnectionProxy::disconnect ( IConnectionPoint *  other )

override

Definition at line 42 of file ConnectionProxy.cpp.

{
   if(other == nullptr)
      return Steinberg::kInvalidArgument;
   if(other != mTarget.get())
      return Steinberg::kResultFalse;
 
   auto result = mSource->disconnect(this);
   if(result == Steinberg::kResultOk)
      mTarget = nullptr;
   return result;
}

notify()

Steinberg::tresult internal::ConnectionProxy::notify ( Steinberg::Vst::IMessage *  message )

override

Definition at line 55 of file ConnectionProxy.cpp.

{
   if(mTarget.get() == nullptr ||
      std::this_thread::get_id() != mThreadId)
      return Steinberg::kResultFalse;
 
   return mTarget->notify(message);
}

Member Data Documentation

DECLARE_FUNKNOWN_METHODS

internal::ConnectionProxy::DECLARE_FUNKNOWN_METHODS

Definition at line 32 of file ConnectionProxy.h.

mSource

Steinberg::IPtr<Steinberg::Vst::IConnectionPoint> internal::ConnectionProxy::mSource

private

Definition at line 28 of file ConnectionProxy.h.

mTarget

Steinberg::IPtr<Steinberg::Vst::IConnectionPoint> internal::ConnectionProxy::mTarget

private

Definition at line 29 of file ConnectionProxy.h.

mThreadId

std::thread::id internal::ConnectionProxy::mThreadId

private

Definition at line 26 of file ConnectionProxy.h.

Referenced by ConnectionProxy().

---

The documentation for this class was generated from the following files:

• ConnectionProxy.h
• ConnectionProxy.cpp