ostinato/common/streambase.h

157 lines
3.7 KiB
C++

/*
Copyright (C) 2010 Srivats P.
This file is part of "Ostinato"
This is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>
*/
#ifndef _STREAM_BASE_H
#define _STREAM_BASE_H
#include <QString>
#include <QLinkedList>
#include "protocol.pb.h"
const int kFcsSize = 4;
class AbstractProtocol;
class ProtocolList;
class ProtocolListIterator;
class StreamBase
{
public:
StreamBase(int portId = -1);
~StreamBase();
void protoDataCopyFrom(const OstProto::Stream &stream);
void protoDataCopyInto(OstProto::Stream &stream) const;
ProtocolListIterator* createProtocolListIterator() const;
//! \todo (LOW) should we have a copy constructor??
public:
enum FrameLengthMode {
e_fl_fixed,
e_fl_inc,
e_fl_dec,
e_fl_random
};
enum SendUnit {
e_su_packets,
e_su_bursts
};
enum SendMode {
e_sm_fixed,
e_sm_continuous
};
enum NextWhat {
e_nw_stop,
e_nw_goto_next,
e_nw_goto_id
};
quint32 id();
bool setId(quint32 id);
#if 0 // FIXME(HI): needed?
quint32 portId()
{ return mCore->port_id();}
bool setPortId(quint32 id)
{ mCore->set_port_id(id); return true;}
#endif
quint32 ordinal();
bool setOrdinal(quint32 ordinal);
bool isEnabled() const;
bool setEnabled(bool flag);
const QString name() const ;
bool setName(QString name) ;
// Frame Length (includes FCS);
FrameLengthMode lenMode() const;
bool setLenMode(FrameLengthMode lenMode);
quint16 frameLen(int streamIndex = 0) const;
bool setFrameLen(quint16 frameLen);
quint16 frameLenMin() const;
bool setFrameLenMin(quint16 frameLenMin);
quint16 frameLenMax() const;
bool setFrameLenMax(quint16 frameLenMax);
quint16 frameLenAvg() const;
SendUnit sendUnit() const;
bool setSendUnit(SendUnit sendUnit);
SendMode sendMode() const;
bool setSendMode(SendMode sendMode);
NextWhat nextWhat() const;
bool setNextWhat(NextWhat nextWhat);
quint32 numPackets() const;
bool setNumPackets(quint32 numPackets);
quint32 numBursts() const;
bool setNumBursts(quint32 numBursts);
quint32 burstSize() const;
bool setBurstSize(quint32 packetsPerBurst);
double packetRate() const;
bool setPacketRate(double packetsPerSec);
double burstRate() const;
bool setBurstRate(double burstsPerSec);
double averagePacketRate() const;
bool setAveragePacketRate(double packetsPerSec);
bool isFrameVariable() const;
bool isFrameSizeVariable() const;
int frameVariableCount() const;
int frameProtocolLength(int frameIndex) const;
int frameCount() const;
int frameValue(uchar *buf, int bufMaxSize, int frameIndex) const;
quint64 deviceMacAddress(int frameIndex) const;
quint64 neighborMacAddress(int frameIndex) const;
bool preflightCheck(QString &result) const;
static bool StreamLessThan(StreamBase* stream1, StreamBase* stream2);
private:
int portId_;
OstProto::StreamId *mStreamId;
OstProto::StreamCore *mCore;
OstProto::StreamControl *mControl;
ProtocolList *currentFrameProtocols;
};
#endif