RawProducer.h

Go to the documentation of this file.

/*! \file RawProducer.h
  \brief  The RawProducer class.  Produces attributes from RAW UDP datagrams.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef _RAW_PRODUCER_H_
#define _RAW_PRODUCER_H_

#include "ChunkProducer.h"

namespace disti
{

class DDD_EXPORT RawProducer : public ChunkProducer
{
public:

    /** Constructor */
    RawProducer();

    /** Processes an inbound message, classifying it into chunks and then updating their associated
      * attributes. 
      * \param msgBuf  A buffer containing a message
      * \param receivedLength The length of the received message
      */
    virtual void ProcessMessage(unsigned char *msgBuf,unsigned int receivedLength);

    /** Builds an outbound message buffer.  Only implemented by ChunkProducers that send data.
      * \param msgBuf  A buffer to contain the message
      * \param maxMessageLength The max length of the message to build
      * \return The length of the message built or -1 if no message built
      */
    virtual int BuildMessage(unsigned char *msgBuf,unsigned int maxMessageLength, unsigned int chunkNumber);

protected:
    virtual void OnAttributeChanged(DDD_AttributeBase *attribute);

private:
    /** \return Returns true if a given rule element fires true based on the current chunk being processed
      * \param element  The rule element to try
      */
    bool MatchRuleElement(RuleElement *element);

    /** \return Returns true if all of the rule elements fire true based on the current chunk being processed
      * \param chunk  The chunk description containing the rules to try
      */
    bool MatchesRule(ChunkDescription *chunk);
};

/** Creator function for RawProducer used by ChunkProducerFactory */
DDD_EXPORT extern ChunkProducer *CreateRawProducer();

} // end of namespace disti

#endif