SHPushPullSH.h

Go to the documentation of this file.

/* Copyright (C) 2000 KOM/Darmstadt University of Technology
 *
 * You are allowed to use all other parts of the code under the following terms:
 *
 * For non-commercial use, code may be used in unmodified form provided
 * that this copyright notice and this permission notice appear in
 * supporting documentation.
 *
 * This software is provided "as is" and without any express or implied
 * warranties, including, without limitation, the implied warranty of
 * fitness for a particular purpose.
 *
 * The code may be subjected to the GNU General Public License, Version 2,
 * and re-distributed under the terms of this license.
 * As a special exception, permission is granted to link this code
 * with the Qt library and distribute executables, as long as you
 * follow the requirements of the GNU GPL in regard to all of the
 * software in the executable aside from Qt.
 *
 * Commercial use other than under the terms of the GNU General Public
 * License is allowed only after express negotiation of conditions
 * with the authors.
 */
#ifndef SH_PUSH_PULL_STREAM_HANDLER_H
#define SH_PUSH_PULL_STREAM_HANDLER_H

#include <sys/types.h>

#include "SH.h"
#include "SHEndpoint.h"
#include "SHEndpointSpec.h"
#include "MNPCList.h"
#include "DummyList.h"
#include "var_type.h"

namespace SH
{

class PushPullSH;
class PushPullSinkEndpoint;
class PushPullSourceEndpoint;

/**********************************************************************/
/* PushPullSinkEndpoint                                           */
/**********************************************************************/

class PushPullSinkEndpoint
    : public SinkEndpoint
{
public:
    PushPullSinkEndpoint( PushPullSH* mySH );
    virtual ~PushPullSinkEndpoint( );

    virtual SH_RC push( DataPtr item );

    PushPullSH* dsh();
};

/**********************************************************************/
/* PushPullSourceEndpoint                                         */
/**********************************************************************/

class PushPullSourceEndpoint
    : public SourceEndpoint
{
public:
    PushPullSourceEndpoint( PushPullSH* mySH );
    virtual ~PushPullSourceEndpoint( );

    virtual SH_RC pull( DataPtr&   item,
                        SourceUnit su = UnitDefault,
                        size_t     amount = 0 );

    PushPullSH* dsh();
};

/**********************************************************************/
/* PushPullSH                                                     */
/**********************************************************************/

class PushPullSH
    : public Base
{
    // this stuff is used in case of PlainData
    MNPCList<DataPtr> _list;
    ProtectedBool     _list_stop_indicator;

    // this stuff is used in case of DummyData
    MNMutex   _dummy_mx;
    DummyList _dummies;
    const char* _debugName;

public:
    SH_RC enqueue( DataPtr  item );
    SH_RC dequeue( DataPtr& item );

public:
    PushPullSH( SHGraphManager* mgr,
                u_int32_t       runtimeId,
                MNSelector&     sel,
                const char *debugName="PushPullSH");
                
                
    virtual ~PushPullSH();

private:

    PushPullSH( const PushPullSH& );

    PushPullSH& operator=( const PushPullSH& );

public:
    virtual SH_RC initSH();
    virtual SH_RC uninitSH();

    virtual SH_RC startStreaming();
    virtual SH_RC stopStreaming();

    SA_PUSH_PULL_LOW_MARK         _low_watermark;
    SA_PUSH_PULL_HIGH_MARK        _high_watermark;
    int32_t                       _packet_count;
    bool                          _notify_low_watermark;
    SA_PUSH_PULL_NONEBLOCKING_POP _noneblockingPop;
    SA_PUSH_PULL_INITIAL_FILL     _initial_fill_size;
    bool                          _initial_fill;
    size_t                        _empty_q_detected;
    SA_RTP_INT_PAYLOAD_TYPE       _int_pt;
    SA_FILE_NAME                  _log_name;

    // Attributes have been moved to SH.h

    /******************************************************************/
    /* functions required for SHStatus                                */
    /******************************************************************/
protected:
    friend class PushPullSinkEndpoint;
    friend class PushPullSourceEndpoint;

    virtual void pushReport( ReportPtr report, Direction d );

    SinkEndpoint*                _in_ep_a[1];
    SourceEndpoint*              _out_ep_a[1];
    PushPullSinkEndpoint       _inEP;
    PushPullSourceEndpoint     _outEP;

public:
    virtual SinkEndpoint**   getSinkSpecs();
    virtual SourceEndpoint** getSourceSpecs();

    virtual bool isConnected() const;

private:
    void private_low_watermark_check( );

    size_t _cnt;

    ostream* _log_file;
};


}; // namespace SH

#endif /* SH_PUSH_PULL_STREAM_HANDLER_H */

---