SHEndpoint.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 MN_SH_ENDPOINT_H
#define MN_SH_ENDPOINT_H

#include <sys/types.h>
#include "var_type.h"

#include "SHEndpointSpec.h"
#include "SHReturnCodes.h"
#include "SHReport.h"
#include "SHData.h"

namespace SH
{
class SourceEndpoint;
class SinkEndpoint;

/**********************************************************************/
/* SourceUnit                                                         */
/**********************************************************************/

enum SourceUnit
{
    UnitDefault,
    UnitBytes,
    UnitPage
};

ostream& operator<<( ostream& ostr, SourceUnit su );

/**********************************************************************/
/* Endpoint                                                           */


class Endpoint
    : public SHEndpointSpec
{
    friend class Base;

public:    

    Endpoint( Base* mySH, bool isSink);

    virtual ~Endpoint();

protected:
    virtual void push_report_to_peer( ReportPtr report ) = 0;

private:
    Endpoint(const Endpoint & orig);

    Endpoint& operator=( const Endpoint& orig );

public:
    void init();

    void uninit();

    virtual void pushReport( ReportPtr report ) = 0;

    virtual SH_RC connect( Endpoint* ep );

    virtual SH_RC disconnect( );

    bool is_connected() const;

    bool is_sink() const;

protected:
// why?
public:
    Base* sh();

    virtual SH_RC changePos( u_int64 pos ) = 0;

private:

    const bool _isSink;

    bool _connected;

    Base* _sh;
};

/**********************************************************************/
/* SinkEndpoint                                                       */
/**********************************************************************/

class SinkEndpoint : public Endpoint
{
    SourceEndpoint* _connected_source;

public:
    SinkEndpoint( Base* mySH );

    virtual SH_RC connect( Endpoint* ep );

    virtual SH_RC disconnect( );

    const SourceEndpoint* getConnectedSourceEndpoint() const;
    virtual SH_RC push( DataPtr item );

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

    virtual void pushReport( ReportPtr report );

    virtual void push_report_to_peer( ReportPtr report );

    virtual SH_RC changePos( u_int64 pos );

};

/**********************************************************************/
/* SourceEndpoint                                                     */
/**********************************************************************/

class SourceEndpoint : public Endpoint
{
    SinkEndpoint* _connected_sink;

public:
    SourceEndpoint( Base* mySH );

    virtual SH_RC connect( Endpoint* ep );

    virtual SH_RC disconnect( );

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

    SH_RC push_to_peer( DataPtr item );

    virtual void push_report_to_peer( ReportPtr report );

    virtual void pushReport( ReportPtr report );

    virtual SH_RC changePos( u_int64 pos );

};

}; // namespace SH

#endif /* MN_SH_ENDPOINT_H */

---