epics::pvAccess::ca::CAChannelPut Class Reference

#include "caChannel.h"

Inheritance diagram for epics::pvAccess::ca::CAChannelPut:

Collaboration diagram for epics::pvAccess::ca::CAChannelPut:

Public Member Functions
	POINTER_DEFINITIONS (CAChannelPut)
virtual	~CAChannelPut ()
void	putDone (struct event_handler_args &args)
void	getDone (struct event_handler_args &args)
virtual void	put (epics::pvData::PVStructure::shared_pointer const &pvPutStructure, epics::pvData::BitSet::shared_pointer const &putBitSet)
virtual void	get ()
virtual Channel::shared_pointer	getChannel ()
virtual void	cancel ()
virtual void	lastRequest ()
virtual std::string	getRequesterName ()
void	activate ()
void	notifyClient ()
Public Member Functions inherited from epics::pvAccess::ChannelPut
	POINTER_DEFINITIONS (ChannelPut)
virtual	~ChannelPut ()
Public Member Functions inherited from epics::pvAccess::ChannelRequest
	POINTER_DEFINITIONS (ChannelRequest)
	ChannelRequest ()
virtual	~ChannelRequest ()
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
Public Member Functions inherited from epics::pvAccess::Lockable
	POINTER_DEFINITIONS (Lockable)
virtual	~Lockable ()
virtual void	lock ()
virtual void	unlock ()

Static Public Member Functions
static CAChannelPut::shared_pointer	create (CAChannel::shared_pointer const &channel, ChannelPutRequester::shared_pointer const &channelPutRequester, epics::pvData::PVStructurePtr const &pvRequest)

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelPut
typedef ChannelPutRequester	requester_type
Static Public Attributes inherited from epics::pvAccess::ChannelRequest
static size_t	num_instances
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 187 of file caChannel.h.

Constructor & Destructor Documentation

epics::pvAccess::ca::CAChannelPut::~CAChannelPut ( )

virtual

Definition at line 582 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelPut::~CAChannelPut() " << channel->getChannelName() << endl;
    }
}

Member Function Documentation

void epics::pvAccess::ca::CAChannelPut::activate

(

)

Definition at line 590 of file caChannel.cpp.

{
    ChannelPutRequester::shared_pointer putRequester(channelPutRequester.lock());
    if(!putRequester) return;
    if(DEBUG_LEVEL>0) {
        cout << "CAChannelPut::activate " << channel->getChannelName() << endl;
    }
    dbdToPv = DbdToPv::create(channel,pvRequest,putIO);
    dbdToPv->getChoices(channel);
    pvStructure = dbdToPv->createPVStructure();
    bitSet = BitSetPtr(new BitSet(pvStructure->getStructure()->getNumberFields()));
    PVStringPtr pvString = pvRequest->getSubField<PVString>("record._options.block");
    if(pvString) {
        std::string val = pvString->get();
        if(val.compare("true")==0) block = true;
    }
    notifyPutRequester = NotifyPutRequesterPtr(new NotifyPutRequester());
    notifyPutRequester->setChannelPut(shared_from_this());
    EXCEPTION_GUARD(putRequester->channelPutConnect(Status::Ok, shared_from_this(),
                    pvStructure->getStructure()));
}

void epics::pvAccess::ca::CAChannelPut::cancel ( )

virtual

Cancel any pending request. Completion will be reported via request's response callback:

• if cancel() request is issued after the request was already complete, request success/failure completion will be reported and cancel() request ignored.
• if the request was actually canceled, cancellation completion is reported.

Implements epics::pvAccess::ChannelRequest.

Definition at line 729 of file caChannel.cpp.

{
}

CAChannelPutPtr epics::pvAccess::ca::CAChannelPut::create ( CAChannel::shared_pointer const &  channel, ChannelPutRequester::shared_pointer const &  channelPutRequester, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Definition at line 557 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannelPut::create " << channel->getChannelName() << endl;
    }
    return CAChannelPutPtr(new CAChannelPut(channel, channelPutRequester, pvRequest));
}

void epics::pvAccess::ca::CAChannelPut::get ( )

virtual

Get the current data.

Ownership transfer as with ChannelGet::get()

Implements epics::pvAccess::ChannelPut.

Definition at line 693 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        std::cout << "CAChannelPut::get " <<  channel->getChannelName() << endl;
    }
    ChannelPutRequester::shared_pointer putRequester(channelPutRequester.lock());
    if(!putRequester) return;
    {
       Lock lock(mutex);
       isPut = false;
    }

    channel->attachContext();
    bitSet->clear();
    int result = ca_array_get_callback(dbdToPv->getRequestType(),
         0,
         channel->getChannelID(), ca_put_get_handler, this);
    if (result == ECA_NORMAL)
    {
        result = ca_flush_io();
    }
    if (result != ECA_NORMAL)
    {
        string mess("CAChannelPut::get ");
        mess += channel->getChannelName() + " message " +ca_message(result);
        Status status(Status::STATUSTYPE_ERROR,mess);
        EXCEPTION_GUARD(putRequester->getDone(status, shared_from_this(), pvStructure, bitSet));
    }
}

Channel::shared_pointer epics::pvAccess::ca::CAChannelPut::getChannel ( )

virtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 724 of file caChannel.cpp.

{
    return channel;
}

void epics::pvAccess::ca::CAChannelPut::getDone

(

struct event_handler_args &

args

)

Definition at line 669 of file caChannel.cpp.

{
     if(DEBUG_LEVEL>1) {
        cout << "CAChannelPut::getDone " << channel->getChannelName() << endl;
    }

    ChannelPutRequester::shared_pointer putRequester(channelPutRequester.lock());
    if(!putRequester) return;
    getStatus = dbdToPv->getFromDBD(pvStructure,bitSet,args);
    putDoneThread->putDone(notifyPutRequester);
}

std::string epics::pvAccess::ca::CAChannelPut::getRequesterName ( )

virtual

Definition at line 612 of file caChannel.cpp.

{ return "CAChannelPut";}

void epics::pvAccess::ca::CAChannelPut::lastRequest ( )

virtual

Announce next request as last request. When last request will be completed (regardless of completion status) the remote and local instance will be destroyed.

Implements epics::pvAccess::ChannelRequest.

Definition at line 733 of file caChannel.cpp.

{
}

void epics::pvAccess::ca::CAChannelPut::notifyClient

(

)

Definition at line 681 of file caChannel.cpp.

{
    ChannelPutRequester::shared_pointer putRequester(channelPutRequester.lock());
    if(!putRequester) return;
    if(isPut) {
        EXCEPTION_GUARD(putRequester->putDone(putStatus, shared_from_this()));
    } else {
        EXCEPTION_GUARD(putRequester->getDone(getStatus, shared_from_this(), pvStructure, bitSet));
    }
}

epics::pvAccess::ca::CAChannelPut::POINTER_DEFINITIONS

(

CAChannelPut

)

void epics::pvAccess::ca::CAChannelPut::put ( epics::pvData::PVStructure::shared_pointer const &  pvPutStructure, epics::pvData::BitSet::shared_pointer const &  putBitSet  )

virtual

Put data to a channel.

Completion status is reported by calling ChannelPutRequester::putDone()

Ownership of the PVStructure is transfered to the ChannelPut until ChannelPutRequester::putDone() or ChannelPutRequester::channelDisconnect() is called.

Parameters

pvPutStructure	The PVStructure that holds the putData.
putBitSet	putPVStructure bit-set (selects what fields to put).

Implements epics::pvAccess::ChannelPut.

Definition at line 634 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        cout << "CAChannelPut::put " << channel->getChannelName() << endl;
    }
    ChannelPutRequester::shared_pointer putRequester(channelPutRequester.lock());
    if(!putRequester) return;
    {
       Lock lock(mutex);
       isPut = true;
    }
    putStatus = dbdToPv->putToDBD(channel,pvPutStructure,block,&ca_put_handler,this);
    if(!block || !putStatus.isOK()) {
        EXCEPTION_GUARD(putRequester->putDone(putStatus, shared_from_this()));
    }
}

void epics::pvAccess::ca::CAChannelPut::putDone

(

struct event_handler_args &

args

)

Definition at line 653 of file caChannel.cpp.

{
     if(DEBUG_LEVEL>1) {
        cout << "CAChannelPut::putDone " << channel->getChannelName() << endl;
    }
    ChannelPutRequester::shared_pointer putRequester(channelPutRequester.lock());
    if(!putRequester) return;
    if(args.status!=ECA_NORMAL)
    {
        putStatus = Status(Status::STATUSTYPE_ERROR, string(ca_message(args.status)));
    } else {
        putStatus = Status::Ok;
    }
    putDoneThread->putDone(notifyPutRequester);
}

---

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

• modules/pvAccess/src/ca/caChannel.h
• modules/pvAccess/src/ca/caChannel.cpp