epics::pvAccess::IntrospectionRegistry Class Reference

#include "introspectionRegistry.h"

Public Member Functions
	IntrospectionRegistry ()
virtual	~IntrospectionRegistry ()
void	reset ()
void	serialize (epics::pvData::FieldConstPtr const &field, epics::pvData::ByteBuffer *buffer, epics::pvData::SerializableControl *control)
epics::pvData::FieldConstPtr	deserialize (epics::pvData::ByteBuffer *buffer, epics::pvData::DeserializableControl *control)

Static Public Attributes
static const epics::pvData::int8	NULL_TYPE_CODE = (int8)-1
static const epics::pvData::int8	ONLY_ID_TYPE_CODE = (int8)-2
static const epics::pvData::int8	FULL_WITH_ID_TYPE_CODE = (int8)-3

Detailed Description

PVData Structure registry. Registry is used to cache introspection interfaces to minimize network traffic.

Author

gjansa

Definition at line 45 of file introspectionRegistry.h.

Constructor & Destructor Documentation

epics::pvAccess::IntrospectionRegistry::IntrospectionRegistry

(

)

Definition at line 23 of file introspectionRegistry.cpp.

{
    reset();
}

epics::pvAccess::IntrospectionRegistry::~IntrospectionRegistry ( )

virtual

Definition at line 28 of file introspectionRegistry.cpp.

{
    reset();
}

Member Function Documentation

FieldConstPtr epics::pvAccess::IntrospectionRegistry::deserialize	(	epics::pvData::ByteBuffer *	buffer,
		epics::pvData::DeserializableControl *	control
	)

Deserializes introspection interface

TODO

Parameters

buffer
control

Returns

Field deserialized from the buffer.

Definition at line 103 of file introspectionRegistry.cpp.

{
    control->ensureData(1);
    size_t pos = buffer->getPosition();
    const int8 typeCode = buffer->getByte();

    if (typeCode == NULL_TYPE_CODE)
    {
        return FieldConstPtr();
    }
    else if (typeCode == ONLY_ID_TYPE_CODE)
    {
        control->ensureData(sizeof(int16));
        int16 id = buffer->getShort();

        registryMap_t::iterator registryIter = _registry.find(id);
        if(registryIter == _registry.end())
        {
            // peer gave us an id which we don't remember.
            // This isn't recoverable.
            throw std::runtime_error("IntrospectionRegistry miss.");
        }
        return registryIter->second;
    }
    // could also be a mask
    if(typeCode == IntrospectionRegistry::FULL_WITH_ID_TYPE_CODE)
    {
        control->ensureData(sizeof(int16)/sizeof(int8));
        const short key = buffer->getShort();
        FieldConstPtr field = _fieldCreate->deserialize(buffer, control);
        _registry[key] = field;
        return field;
    }

    // return typeCode back
    buffer->setPosition(pos);
    return _fieldCreate->deserialize(buffer, control);
}

void epics::pvAccess::IntrospectionRegistry::reset

(

)

Resets registry, i.e. must be done when transport is changed (server restarted).

Definition at line 33 of file introspectionRegistry.cpp.

{
    _pointer = 1;
    _registry.clear();
}

void epics::pvAccess::IntrospectionRegistry::serialize	(	epics::pvData::FieldConstPtr const &	field,
		epics::pvData::ByteBuffer *	buffer,
		epics::pvData::SerializableControl *	control
	)

Serializes introspection interface

Parameters

field
buffer
control

Definition at line 70 of file introspectionRegistry.cpp.

{
    if (field.get() == NULL)
    {
        SerializationHelper::serializeNullField(buffer, control);
    }
    else
    {
        // do not cache scalars, scalarArrays
        // ... and (array of) variant unions - not worth the complex condition,
        // unless bool Field.cache() would exist
        if (field->getType() != scalar &&
                field->getType() != scalarArray)
        {
            bool existing;
            const int16 key = registerIntrospectionInterface(field, existing);
            if (existing) {
                control->ensureBuffer(3);
                buffer->putByte(ONLY_ID_TYPE_CODE);
                buffer->putShort(key);
                return;
            }
            else {
                control->ensureBuffer(3);
                buffer->putByte(FULL_WITH_ID_TYPE_CODE);    // could also be a mask
                buffer->putShort(key);
            }
        }

        field->serialize(buffer, control);
    }
}

Member Data Documentation

const int8 epics::pvAccess::IntrospectionRegistry::FULL_WITH_ID_TYPE_CODE = (int8)-3

static

Serialization contains an ID (that can be used later, if cached) and full interface description.

Definition at line 103 of file introspectionRegistry.h.

const int8 epics::pvAccess::IntrospectionRegistry::NULL_TYPE_CODE = (int8)-1

static

Null type.

Definition at line 93 of file introspectionRegistry.h.

const int8 epics::pvAccess::IntrospectionRegistry::ONLY_ID_TYPE_CODE = (int8)-2

static

Serialization contains only an ID (that was assigned by one of the previous FULL_WITH_ID descriptions).

Definition at line 98 of file introspectionRegistry.h.

---

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

• modules/pvAccess/src/utils/pv/introspectionRegistry.h
• modules/pvAccess/src/utils/introspectionRegistry.cpp