opentxs::OTCaller Class Reference

#include <OTCaller.hpp>

Collaboration diagram for opentxs::OTCaller:

Public Member Functions
	OTCaller ()
EXPORT	~OTCaller ()
EXPORT bool	GetPassword (OTPassword &theOutput) const
EXPORT void	ZeroOutPassword ()
EXPORT const char *	GetDisplay () const
EXPORT void	SetDisplay (const char *szDisplay, int32_t nLength)
EXPORT void	delCallback ()
EXPORT void	setCallback (OTCallback *cb)
EXPORT bool	isCallbackSet () const
EXPORT void	callOne ()
EXPORT void	callTwo ()

Protected Attributes
OTPassword	m_Password
OTPassword	m_Display
OTCallback *	_callback

Detailed Description

Definition at line 344 of file OTCaller.hpp.

Constructor & Destructor Documentation

opentxs::OTCaller::OTCaller ( )

inline

Definition at line 357 of file OTCaller.hpp.

        : _callback(nullptr)
    {
    }

opentxs::OTCaller::~OTCaller

(

)

Definition at line 168 of file OTCaller.cpp.

{
    otOut << "OTCaller::~OTCaller: (This should only happen as the application "
             "is closing.)\n";

    delCallback();
}

Member Function Documentation

void opentxs::OTCaller::callOne

(

)

Definition at line 261 of file OTCaller.cpp.

{
    ZeroOutPassword(); // Make sure there isn't some old password still in here.

    if (isCallbackSet()) {
        otOut
            << "OTCaller::callOne: FYI, Executing password callback (one)...\n";
        _callback->runOne(GetDisplay(), m_Password);
    }
    else {
        otOut << "OTCaller::callOne: WARNING: Failed attempt to trigger "
                 "password callback (one), due to \"it hasn't been set "
                 "yet.\"\n";
    }
}

void opentxs::OTCaller::callTwo

(

)

Definition at line 277 of file OTCaller.cpp.

{
    ZeroOutPassword(); // Make sure there isn't some old password still in here.

    if (isCallbackSet()) {
        otOut
            << "OTCaller::callTwo: FYI, Executing password callback (two)...\n";
        _callback->runTwo(GetDisplay(), m_Password);
    }
    else {
        otOut << "OTCaller::callTwo: WARNING: Failed attempt to trigger "
                 "password callback (two), due to \"it hasn't been set "
                 "yet.\"\n";
    }
}

void opentxs::OTCaller::delCallback

(

)

Definition at line 221 of file OTCaller.cpp.

{
    //    if (nullptr != _callback)  // TODO this may be a memory leak.
    //        delete _callback;    // But I know we're currently crashing from
    // deleting same object twice.
    // And since the object comes from Java, who am I to delete it? Let Java
    // clean it up.
    if (isCallbackSet())
        otOut << "OTCaller::delCallback: WARNING: setting existing callback "
                 "object pointer to nullptr. "
                 "(This message doesn't trigger if it was already nullptr.)\n";

    _callback = nullptr;
}

const char * opentxs::OTCaller::GetDisplay

(

)

const

Definition at line 179 of file OTCaller.cpp.

{
    // I'm using the OTPassword class to store the display string, in addition
    // to
    // storing the password itself. (For convenience.)
    //
    return reinterpret_cast<const char*>(m_Display.getPassword_uint8());
}

bool opentxs::OTCaller::GetPassword

(

OTPassword &

theOutput

)

const

Definition at line 204 of file OTCaller.cpp.

{
    otOut << "OTCaller::GetPassword: FYI, returning password after invoking a "
             "(probably Java) password dialog.\n";

    theOutput.setPassword_uint8(m_Password.getPassword_uint8(),
                                m_Password.getPasswordSize());

    return true;
}

bool opentxs::OTCaller::isCallbackSet

(

)

const

Definition at line 256 of file OTCaller.cpp.

{
    return (nullptr == _callback) ? false : true;
}

void opentxs::OTCaller::setCallback

(

OTCallback *

cb

)

Definition at line 236 of file OTCaller.cpp.

{
    otOut << "OTCaller::setCallback: Attempting to set the password OTCallback "
             "pointer...\n";

    if (nullptr == cb) {
        otOut << "OTCaller::setCallback: ERROR: nullptr password OTCallback "
                 "object passed in. (Returning.)\n";
        return;
    }

    delCallback(); // Sets _callback to nullptr, but LOGS first, if it was
                   // already
                   // set.

    _callback = cb;
    otOut << "OTCaller::setCallback: FYI, the password OTCallback pointer was "
             "set.\n";
}

void opentxs::OTCaller::SetDisplay	(	const char *	szDisplay,
		int32_t	nLength
	)

Definition at line 191 of file OTCaller.cpp.

{
    // I'm using the OTPassword class to store the display string, in addition
    // to
    // storing the password itself. (For convenience.)
    //
    m_Display.setPassword_uint8(reinterpret_cast<const uint8_t*>(szDisplay),
                                nLength);
}

void opentxs::OTCaller::ZeroOutPassword

(

)

Definition at line 215 of file OTCaller.cpp.

{
    if (m_Password.getPasswordSize() > 0) m_Password.zeroMemory();
}

Member Data Documentation

OTCallback* opentxs::OTCaller::_callback

protected

Definition at line 354 of file OTCaller.hpp.

OTPassword opentxs::OTCaller::m_Display

protected

Definition at line 350 of file OTCaller.hpp.

OTPassword opentxs::OTCaller::m_Password

protected

Definition at line 347 of file OTCaller.hpp.

---

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

• /usr/local/src/opentxs/include/opentxs/core/crypto/OTCaller.hpp
• /usr/local/src/opentxs/src/core/crypto/OTCaller.cpp