epics::pvAccess::ca::CAChannelGet Class Reference

#include "caChannel.h"

Inheritance diagram for epics::pvAccess::ca::CAChannelGet:

Collaboration diagram for epics::pvAccess::ca::CAChannelGet:

Public Member Functions
	POINTER_DEFINITIONS (CAChannelGet)
virtual	~CAChannelGet ()
void	getDone (struct event_handler_args &args)
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::ChannelGet
	POINTER_DEFINITIONS (ChannelGet)
virtual	~ChannelGet ()
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 CAChannelGet::shared_pointer	create (CAChannel::shared_pointer const &channel, ChannelGetRequester::shared_pointer const &channelGetRequester, epics::pvData::PVStructurePtr const &pvRequest)

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelGet
typedef ChannelGetRequester	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 150 of file caChannel.h.

Constructor & Destructor Documentation

epics::pvAccess::ca::CAChannelGet::~CAChannelGet ( )

virtual

Definition at line 458 of file caChannel.cpp.

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

Member Function Documentation

void epics::pvAccess::ca::CAChannelGet::activate

(

)

Definition at line 465 of file caChannel.cpp.

{
    ChannelGetRequester::shared_pointer getRequester(channelGetRequester.lock());
    if(!getRequester) return;
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelGet::activate " <<  channel->getChannelName() << endl;
    }
    dbdToPv = DbdToPv::create(channel,pvRequest,getIO);
    dbdToPv->getChoices(channel);
    pvStructure = dbdToPv->createPVStructure();
    bitSet = BitSetPtr(new BitSet(pvStructure->getStructure()->getNumberFields()));
    notifyGetRequester = NotifyGetRequesterPtr(new NotifyGetRequester());
    notifyGetRequester->setChannelGet(shared_from_this());
    EXCEPTION_GUARD(getRequester->channelGetConnect(Status::Ok, shared_from_this(),
                    pvStructure->getStructure()));
}

void epics::pvAccess::ca::CAChannelGet::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 549 of file caChannel.cpp.

{
}

CAChannelGetPtr epics::pvAccess::ca::CAChannelGet::create ( CAChannel::shared_pointer const &  channel, ChannelGetRequester::shared_pointer const &  channelGetRequester, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Definition at line 436 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannelGet::create " << channel->getChannelName() << endl;
    }
    return CAChannelGetPtr(new CAChannelGet(channel, channelGetRequester, pvRequest));
}

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

virtual

Get data from the channel.

Ownership of the PVStructure passed to ChannelGetRequester::getDone() is returned to the ChannelGet.

Completion status is reported by calling ChannelGetRequester::getDone() callback.

Implements epics::pvAccess::ChannelGet.

Definition at line 519 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        std::cout << "CAChannelGet::get " <<  channel->getChannelName() << endl;
    }
    ChannelGetRequester::shared_pointer getRequester(channelGetRequester.lock());
    if(!getRequester) return;
    channel->attachContext();
    bitSet->clear();
    int result = ca_array_get_callback(dbdToPv->getRequestType(),
         0,
         channel->getChannelID(), ca_get_handler, this);
    if (result == ECA_NORMAL)
    {
        result = ca_flush_io();
    }
    if (result != ECA_NORMAL)
    {
        string mess("CAChannelGet::get ");
        mess += channel->getChannelName() + " message " + ca_message(result);
        getStatus = Status(Status::STATUSTYPE_ERROR,mess);
        notifyClient();
    }
}

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

virtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 544 of file caChannel.cpp.

{
    return channel;
}

void epics::pvAccess::ca::CAChannelGet::getDone

(

struct event_handler_args &

args

)

Definition at line 496 of file caChannel.cpp.

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

    ChannelGetRequester::shared_pointer getRequester(channelGetRequester.lock());
    if(!getRequester) return;
    getStatus = dbdToPv->getFromDBD(pvStructure,bitSet,args);
    getDoneThread->getDone(notifyGetRequester);
}

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

virtual

Definition at line 484 of file caChannel.cpp.

{ return "CAChannelGet";}

void epics::pvAccess::ca::CAChannelGet::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 553 of file caChannel.cpp.

{
}

void epics::pvAccess::ca::CAChannelGet::notifyClient

(

)

Definition at line 509 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        std::cout << "CAChannelGet::notifyClient " <<  channel->getChannelName() << endl;
    }
    ChannelGetRequester::shared_pointer getRequester(channelGetRequester.lock());
    if(!getRequester) return;
    EXCEPTION_GUARD(getRequester->getDone(getStatus, shared_from_this(), pvStructure, bitSet));
}

epics::pvAccess::ca::CAChannelGet::POINTER_DEFINITIONS

(

CAChannelGet

)

---

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

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