The contents of this legacy page are no longer maintained nor supported, and are made available only for historical purposes.


CflowdRawFlow Documentation

CflowdRawFlow


[ libCfd | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

DESCRIPTION

Class Summary

class CflowdRawFlow

{

public:
typedef uint32_t index_type;
const index_type k_routerMask = 0x00000001;
const index_type k_srcIpAddrMask = 0x00000002;
const index_type k_dstIpAddrMask = 0x00000004;
const index_type k_inputIfIndexMask = 0x00000008;
const index_type k_outputIfIndexMask = 0x00000010;
const index_type k_srcPortMask = 0x00000020;
const index_type k_dstPortMask = 0x00000040;
const index_type k_pktsMask = 0x00000080;
const index_type k_bytesMask = 0x00000100;
const index_type k_ipNextHopMask = 0x00000200;
const index_type k_startTimeMask = 0x00000400;
const index_type k_endTimeMask = 0x00000800;
const index_type k_protocolMask = 0x00001000;
const index_type k_tosMask = 0x00002000;
const index_type k_srcAsMask = 0x00004000;
const index_type k_dstAsMask = 0x00008000;
const index_type k_srcMaskLenMask = 0x00010000;
const index_type k_dstMaskLenMask = 0x00020000;
const index_type k_tcpFlagsMask = 0x00040000;
const index_type k_inputEncapMask = 0x00080000;
const index_type k_outputEncapMask = 0x00100000;
const index_type k_peerNextHopMask = 0x00200000;
const index_type k_engineTypeMask = 0x00400000;
const index_type k_engineIdMask = 0x00800000;
CflowdRawFlow();
CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV1_t * flowHeader, const CiscoFlowEntryV1_t * flowEntry);
CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV5_t * flowHeader, const CiscoFlowEntryV5_t * flowEntry);
CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV6_t * flowHeader, const CiscoFlowEntryV6_t * flowEntry);
index_type Index() const ;
ipv4addr_t Router() const ;
ipv4addr_t Router(ipv4addr_t router) ;
ipv4addr_t SrcIpAddr() const ;
ipv4addr_t SrcIpAddr(ipv4addr_t srcIpAddr) ;
ipv4addr_t DstIpAddr() const ;
ipv4addr_t DstIpAddr(ipv4addr_t dstIpAddr) ;
uint16_t InputIfIndex() const ;
uint16_t InputIfIndex(uint16_t inputIfIndex) ;
uint16_t OutputIfIndex() const ;
uint16_t OutputIfIndex(uint16_t outputIfIndex) ;
uint16_t SrcPort() const ;
uint16_t SrcPort(uint16_t srcPort) ;
uint16_t DstPort() const ;
uint16_t DstPort(uint16_t dstPort) ;
uint32_t Pkts() const ;
uint32_t Pkts(uint32_t pkts) ;
uint32_t Bytes() const ;
uint32_t Bytes(uint32_t bytes) ;
ipv4addr_t IpNextHop() const ;
ipv4addr_t IpNextHop(ipv4addr_t ipNextHop) ;
uint32_t StartTime() const ;
uint32_t StartTime(uint32_t startTime) ;
uint32_t EndTime() const ;
uint32_t EndTime(uint32_t endTime) ;
uint8_t Protocol() const ;
uint8_t Protocol(uint8_t protocol) ;
uint8_t Tos() const ;
uint8_t Tos(uint8_t tos) ;
uint16_t SrcAs() const ;
uint16_t SrcAs(uint16_t srcAs) ;
uint16_t DstAs() const ;
uint16_t DstAs(uint16_t dstAs) ;
uint8_t SrcMaskLen() const ;
uint8_t SrcMaskLen(uint8_t srcMaskLen) ;
uint8_t DstMaskLen() const ;
uint8_t DstMaskLen(uint8_t dstMaskLen) ;
uint8_t TcpFlags() const ;
uint8_t TcpFlags(uint8_t tcpFlags) ;
uint8_t InputEncap() const ;
uint8_t InputEncap(uint8_t inputEncap) ;
uint8_t OutputEncap() const ;
uint8_t OutputEncap(uint8_t outputEncap) ;
ipv4addr_t PeerNextHop() const ;
ipv4addr_t PeerNextHop(ipv4addr_t peerNextHop) ;
uint8_t EngineType() const ;
uint8_t EngineType(uint8_t engineType) ;
uint8_t EngineId() const ;
uint8_t EngineId(uint8_t engineId) ;
uint8_t Version() const ;
uint8_t Version(uint8_t version) ;
istream & Read(istream & is);
int Read(int fd);
ostream & Write(ostream & os);
int Write(int fd);
friend ostream& operator << (ostream& os, const CflowdRawFlow & flow);
protected:
}; // CflowdRawFlow

Back to the top of CflowdRawFlow


DESCRIPTION


---------------------------------------------------------------------------
class CflowdRawFlow
---------------------------------------------------------------------------
This class abstracts a raw flow from Cisco's flow-export. It is used by cflowdmux to send raw flows to clients, including cflowd.

The motivation for the multiple constructors: provide a means of dealing with multiple versions of Cisco flow-export that's not too painful for the class library user. As new version of flow-export come along, we should be able to just add new constructors and possibly new data and access members (if the new flow-export version has additional information not contained in current versions).
---------------------------------------------------------------------------

Back to the top of CflowdRawFlow


typedef uint32_t index_type;

No documentation available.

  typedef uint32_t index_type;

Back to the top of CflowdRawFlow


const index_type k_routerMask = 0x00000001;

  const index_type k_routerMask        = 0x00000001;

Back to the top of CflowdRawFlow


const index_type k_srcIpAddrMask = 0x00000002;

No documentation available.

  const index_type k_srcIpAddrMask     = 0x00000002;

Back to the top of CflowdRawFlow


const index_type k_dstIpAddrMask = 0x00000004;

No documentation available.

  const index_type k_dstIpAddrMask     = 0x00000004;

Back to the top of CflowdRawFlow


const index_type k_inputIfIndexMask = 0x00000008;

No documentation available.

  const index_type k_inputIfIndexMask  = 0x00000008;

Back to the top of CflowdRawFlow


const index_type k_outputIfIndexMask = 0x00000010;

No documentation available.

  const index_type k_outputIfIndexMask = 0x00000010;

Back to the top of CflowdRawFlow


const index_type k_srcPortMask = 0x00000020;

No documentation available.

  const index_type k_srcPortMask       = 0x00000020;

Back to the top of CflowdRawFlow


const index_type k_dstPortMask = 0x00000040;

No documentation available.

  const index_type k_dstPortMask       = 0x00000040;

Back to the top of CflowdRawFlow


const index_type k_pktsMask = 0x00000080;

No documentation available.

  const index_type k_pktsMask          = 0x00000080;

Back to the top of CflowdRawFlow


const index_type k_bytesMask = 0x00000100;

No documentation available.

  const index_type k_bytesMask         = 0x00000100;

Back to the top of CflowdRawFlow


const index_type k_ipNextHopMask = 0x00000200;

No documentation available.

  const index_type k_ipNextHopMask     = 0x00000200;

Back to the top of CflowdRawFlow


const index_type k_startTimeMask = 0x00000400;

No documentation available.

  const index_type k_startTimeMask     = 0x00000400;

Back to the top of CflowdRawFlow


const index_type k_endTimeMask = 0x00000800;

No documentation available.

  const index_type k_endTimeMask       = 0x00000800;

Back to the top of CflowdRawFlow


const index_type k_protocolMask = 0x00001000;

No documentation available.

  const index_type k_protocolMask      = 0x00001000;

Back to the top of CflowdRawFlow


const index_type k_tosMask = 0x00002000;

No documentation available.

  const index_type k_tosMask           = 0x00002000;

Back to the top of CflowdRawFlow


const index_type k_srcAsMask = 0x00004000;

No documentation available.

  const index_type k_srcAsMask         = 0x00004000;

Back to the top of CflowdRawFlow


const index_type k_dstAsMask = 0x00008000;

No documentation available.

  const index_type k_dstAsMask         = 0x00008000;

Back to the top of CflowdRawFlow


const index_type k_srcMaskLenMask = 0x00010000;

No documentation available.

  const index_type k_srcMaskLenMask    = 0x00010000;

Back to the top of CflowdRawFlow


const index_type k_dstMaskLenMask = 0x00020000;

No documentation available.

  const index_type k_dstMaskLenMask    = 0x00020000;

Back to the top of CflowdRawFlow


const index_type k_tcpFlagsMask = 0x00040000;

No documentation available.

  const index_type k_tcpFlagsMask      = 0x00040000;

Back to the top of CflowdRawFlow


const index_type k_inputEncapMask = 0x00080000;

No documentation available.

  const index_type k_inputEncapMask    = 0x00080000;

Back to the top of CflowdRawFlow


const index_type k_outputEncapMask = 0x00100000;

No documentation available.

  const index_type k_outputEncapMask   = 0x00100000;

Back to the top of CflowdRawFlow


const index_type k_peerNextHopMask = 0x00200000;

No documentation available.

  const index_type k_peerNextHopMask   = 0x00200000;

Back to the top of CflowdRawFlow


const index_type k_engineTypeMask = 0x00400000;

No documentation available.

  const index_type k_engineTypeMask    = 0x00400000;

Back to the top of CflowdRawFlow


const index_type k_engineIdMask = 0x00800000;

No documentation available.

  const index_type k_engineIdMask      = 0x00800000;

Back to the top of CflowdRawFlow


CflowdRawFlow();


-------------------------------------------------------------------------
CflowdRawFlow()
.........................................................................
constructor
-------------------------------------------------------------------------

  CflowdRawFlow();

Back to the top of CflowdRawFlow


CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV1_t * flowHeader, const CiscoFlowEntryV1_t * flowEntry);


-------------------------------------------------------------------------
CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV1_t * flowHeader, const CiscoFlowEntryV1_t * flowEntry)
.........................................................................
Constructs from an IP address (of the Cisco sending the flow data) and a pointer to a v1 flow header and a v1 flow entry.
-------------------------------------------------------------------------

  CflowdRawFlow(ipv4addr_t ciscoIp,
                const CiscoFlowHeaderV1_t * flowHeader,
                const CiscoFlowEntryV1_t * flowEntry);

Back to the top of CflowdRawFlow


CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV5_t * flowHeader, const CiscoFlowEntryV5_t * flowEntry);


-------------------------------------------------------------------------
CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV5_t * flowHeader, const CiscoFlowEntryV5_t * flowEntry)
.........................................................................
Constructs from an IP address (of the Cisco sending the flow data) and a pointer to a v5 flow header and a v5 flow entry.
-------------------------------------------------------------------------

  CflowdRawFlow(ipv4addr_t ciscoIp,
                const CiscoFlowHeaderV5_t * flowHeader,
                const CiscoFlowEntryV5_t * flowEntry);

Back to the top of CflowdRawFlow


CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV6_t * flowHeader, const CiscoFlowEntryV6_t * flowEntry);


-------------------------------------------------------------------------
CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV6_t * flowHeader, const CiscoFlowEntryV6_t * flowEntry)
.........................................................................
Constructs from an IP address (of the Cisco sending the flow data) and a pointer to a v6 flow header and a v6 flow entry.
-------------------------------------------------------------------------

  CflowdRawFlow(ipv4addr_t ciscoIp,
                const CiscoFlowHeaderV6_t * flowHeader,
                const CiscoFlowEntryV6_t * flowEntry);

Back to the top of CflowdRawFlow


index_type Index() const ;

CflowdRawFlow(ipv4addr_t ciscoIp, const CiscoFlowHeaderV8_t * flowHeader, const CiscoFlowEntryV8_t * flowEntry);
-------------------------------------------------------------------------
inline index_type Index() const
.........................................................................
Returns the bitfield index. The index has a bit set for each of the pieces of data contained in the flow. If the bit is set, the corresponding data is present.
-------------------------------------------------------------------------

  inline index_type Index() const
                                 
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t Router() const ;


-------------------------------------------------------------------------
inline ipv4addr_t Router() const
.........................................................................
Returns the IP address of the router that sent the flow data.
-------------------------------------------------------------------------

  inline ipv4addr_t Router() const
                                  
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t Router(ipv4addr_t router) ;


-------------------------------------------------------------------------
inline ipv4addr_t Router(ipv4addr_t router)
.........................................................................
Sets and returns the IP address of the router that sent the flow data.
-------------------------------------------------------------------------

  inline ipv4addr_t Router(ipv4addr_t router)
                                                                                                
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t SrcIpAddr() const ;


-------------------------------------------------------------------------
inline ipv4addr_t SrcIpAddr() const
.........................................................................
Returns the IP address of the host that sourced the flow.
-------------------------------------------------------------------------

  inline ipv4addr_t SrcIpAddr() const
                                     
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t SrcIpAddr(ipv4addr_t srcIpAddr) ;


-------------------------------------------------------------------------
inline ipv4addr_t SrcIpAddr(ipv4addr_t srcIpAddr)
.........................................................................
Sets and returns the IP address of the host that sourced the flow.
-------------------------------------------------------------------------

  inline ipv4addr_t SrcIpAddr(ipv4addr_t srcIpAddr)
                                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t DstIpAddr() const ;


-------------------------------------------------------------------------
inline ipv4addr_t DstIpAddr() const
.........................................................................
Returns the IP address of the host that sinked the flow.
-------------------------------------------------------------------------

  inline ipv4addr_t DstIpAddr() const
                                     
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t DstIpAddr(ipv4addr_t dstIpAddr) ;


-------------------------------------------------------------------------
inline ipv4addr_t DstIpAddr(ipv4addr_t dstIpAddr)
.........................................................................
Sets and returns the IP address of the host that sinked the flow.
-------------------------------------------------------------------------

  inline ipv4addr_t DstIpAddr(ipv4addr_t dstIpAddr)
                                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t InputIfIndex() const ;


-------------------------------------------------------------------------
inline uint16_t InputIfIndex() const
.........................................................................
Returns the ifIndex of the interface which received the flow.
-------------------------------------------------------------------------

  inline uint16_t InputIfIndex() const
                                        
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t InputIfIndex(uint16_t inputIfIndex) ;


-------------------------------------------------------------------------
inline uint16_t InputIfIndex(uint16_t inputIfIndex)
.........................................................................
Sets and returns the ifIndex of the interface which received the flow.
-------------------------------------------------------------------------

  inline uint16_t InputIfIndex(uint16_t inputIfIndex)
                                                                                                                        
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t OutputIfIndex() const ;


-------------------------------------------------------------------------
inline uint16_t OutputIfIndex() const
.........................................................................
Returns the ifIndex of the interface which transmitted the flow to the destination.
-------------------------------------------------------------------------

  inline uint16_t OutputIfIndex() const
                                         
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t OutputIfIndex(uint16_t outputIfIndex) ;


-------------------------------------------------------------------------
inline uint16_t OutputIfIndex(uint16_t outputIfIndex)
.........................................................................
Sets and returns the ifIndex of the interface which transmitted the flow to the destination.
-------------------------------------------------------------------------

  inline uint16_t OutputIfIndex(uint16_t outputIfIndex)
                                                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t SrcPort() const ;


-------------------------------------------------------------------------
inline uint16_t SrcPort() const
.........................................................................
Returns the transport source port number.
-------------------------------------------------------------------------

  inline uint16_t SrcPort() const
                                   
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t SrcPort(uint16_t srcPort) ;


-------------------------------------------------------------------------
inline uint16_t SrcPort(uint16_t srcPort)
.........................................................................
Sets and returns the transport source port number.
-------------------------------------------------------------------------

  inline uint16_t SrcPort(uint16_t srcPort)
                                                                                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t DstPort() const ;


-------------------------------------------------------------------------
inline uint16_t DstPort() const
.........................................................................
Returns the transport destination port number.
-------------------------------------------------------------------------

  inline uint16_t DstPort() const
                                   
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t DstPort(uint16_t dstPort) ;


-------------------------------------------------------------------------
inline uint16_t DstPort(uint16_t dstPort)
.........................................................................
Sets and returns the transport destination port number.
-------------------------------------------------------------------------

  inline uint16_t DstPort(uint16_t dstPort)
                                                                                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t Pkts() const ;


-------------------------------------------------------------------------
inline uint32_t Pkts() const
.........................................................................
Returns the number of packets in the flow.
-------------------------------------------------------------------------

  inline uint32_t Pkts() const
                                
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t Pkts(uint32_t pkts) ;


-------------------------------------------------------------------------
inline uint32_t Pkts(uint32_t pkts)
.........................................................................
Sets and returns the number of packets in the flow.
-------------------------------------------------------------------------

  inline uint32_t Pkts(uint32_t pkts)
                                                                                        
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t Bytes() const ;


-------------------------------------------------------------------------
inline uint32_t Bytes() const
.........................................................................
Returns the number of bytes in the flow.
-------------------------------------------------------------------------

  inline uint32_t Bytes() const
                                 
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t Bytes(uint32_t bytes) ;


-------------------------------------------------------------------------
inline uint32_t Bytes(uint32_t bytes)
.........................................................................
Sets and returns the number of bytes in the flow.
-------------------------------------------------------------------------

  inline uint32_t Bytes(uint32_t bytes)
                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t IpNextHop() const ;


-------------------------------------------------------------------------
inline ipv4addr_t IpNextHop() const
.........................................................................
Returns the IP next hop for the flow. This is relative to the router.
-------------------------------------------------------------------------

  inline ipv4addr_t IpNextHop() const
                                     
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t IpNextHop(ipv4addr_t ipNextHop) ;


-------------------------------------------------------------------------
inline ipv4addr_t IpNextHop(ipv4addr_t ipNextHop)
.........................................................................
Sets and returns the IP next hop for the flow. This is relative to the router.
-------------------------------------------------------------------------

  inline ipv4addr_t IpNextHop(ipv4addr_t ipNextHop)
                                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t StartTime() const ;


-------------------------------------------------------------------------
inline uint32_t StartTime() const
.........................................................................
Returns the start time of the flow.
-------------------------------------------------------------------------

  inline uint32_t StartTime() const
                                     
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t StartTime(uint32_t startTime) ;


-------------------------------------------------------------------------
inline uint32_t StartTime(uint32_t startTime)
.........................................................................
Sets and returns the start time of the flow.
-------------------------------------------------------------------------

  inline uint32_t StartTime(uint32_t startTime)
                                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t EndTime() const ;


-------------------------------------------------------------------------
inline uint32_t EndTime() const
.........................................................................
Returns the end time of the flow.
-------------------------------------------------------------------------

  inline uint32_t EndTime() const
                                   
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint32_t EndTime(uint32_t endTime) ;


-------------------------------------------------------------------------
inline uint32_t EndTime(uint32_t endTime)
.........................................................................
Sets and returns the end time of the flow.
-------------------------------------------------------------------------

  inline uint32_t EndTime(uint32_t endTime)
                                                                                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t Protocol() const ;


-------------------------------------------------------------------------
inline uint8_t Protocol() const
.........................................................................
Returns the IP protocol (ICMP, UDP, TCP, etc.) of the flow.
-------------------------------------------------------------------------

  inline uint8_t Protocol() const
                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t Protocol(uint8_t protocol) ;


-------------------------------------------------------------------------
inline uint8_t Protocol(uint8_t protocol)
.........................................................................
Sets and returns the IP protocol (ICMP, UDP, TCP, etc.) of the flow.
-------------------------------------------------------------------------

  inline uint8_t Protocol(uint8_t protocol)
                                                                                                        
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t Tos() const ;


-------------------------------------------------------------------------
inline uint8_t Tos() const
.........................................................................
Returns the TOS (type of service) of the flow.
-------------------------------------------------------------------------

  inline uint8_t Tos() const
                               
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t Tos(uint8_t tos) ;


-------------------------------------------------------------------------
inline uint8_t Tos(uint8_t tos)
.........................................................................
Sets and returns the TOS (type of service) of the flow.
-------------------------------------------------------------------------

  inline uint8_t Tos(uint8_t tos)
                                                                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t SrcAs() const ;


-------------------------------------------------------------------------
inline uint16_t SrcAs() const
.........................................................................
Returns the source AS of the flow.
-------------------------------------------------------------------------

  inline uint16_t SrcAs() const
                                 
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t SrcAs(uint16_t srcAs) ;


-------------------------------------------------------------------------
inline uint16_t SrcAs(uint16_t srcAs)
.........................................................................
Sets and returns the source AS of the flow.
-------------------------------------------------------------------------

  inline uint16_t SrcAs(uint16_t srcAs)
                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t DstAs() const ;


-------------------------------------------------------------------------
inline uint16_t DstAs() const
.........................................................................
Returns the destination AS of the flow.
-------------------------------------------------------------------------

  inline uint16_t DstAs() const
                                 
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint16_t DstAs(uint16_t dstAs) ;


-------------------------------------------------------------------------
inline uint16_t DstAs(uint16_t dstAs)
.........................................................................
Sets and returns the destination AS of the flow.
-------------------------------------------------------------------------

  inline uint16_t DstAs(uint16_t dstAs)
                                                                                            
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t SrcMaskLen() const ;


-------------------------------------------------------------------------
inline uint8_t SrcMaskLen() const
.........................................................................
Returns the source network mask length of the flow.
-------------------------------------------------------------------------

  inline uint8_t SrcMaskLen() const
                                      
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t SrcMaskLen(uint8_t srcMaskLen) ;


-------------------------------------------------------------------------
inline uint8_t SrcMaskLen(uint8_t srcMaskLen)
.........................................................................
Sets and returns the source network mask length of the flow.
-------------------------------------------------------------------------

  inline uint8_t SrcMaskLen(uint8_t srcMaskLen)
                                                                                                                
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t DstMaskLen() const ;


-------------------------------------------------------------------------
inline uint8_t DstMaskLen() const
.........................................................................
Returns the destination network mask length of the flow.
-------------------------------------------------------------------------

  inline uint8_t DstMaskLen() const
                                      
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t DstMaskLen(uint8_t dstMaskLen) ;


-------------------------------------------------------------------------
inline uint8_t DstMaskLen(uint8_t dstMaskLen)
.........................................................................
Sets and returns the destination network mask length of the flow.
-------------------------------------------------------------------------

  inline uint8_t DstMaskLen(uint8_t dstMaskLen)
                                                                                                                
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t TcpFlags() const ;


-------------------------------------------------------------------------
inline uint8_t TcpFlags() const
.........................................................................
Returns the bitwise OR of all the TCP flags seen in the flow. Not applicable if the flow was not a TCP flow.
-------------------------------------------------------------------------

  inline uint8_t TcpFlags() const
                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t TcpFlags(uint8_t tcpFlags) ;


-------------------------------------------------------------------------
inline uint8_t TcpFlags(uint8_t tcpFlags)
.........................................................................
Sets and returns the bitwise OR of all the TCP flags seen in the flow. Not applicable if the flow was not a TCP flow.
-------------------------------------------------------------------------

  inline uint8_t TcpFlags(uint8_t tcpFlags)
                                                                                                        
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t InputEncap() const ;


-------------------------------------------------------------------------
inline uint8_t InputEncap() const
.........................................................................
Returns the input encapsulation of the flow.
-------------------------------------------------------------------------

  inline uint8_t InputEncap() const
                                      
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t InputEncap(uint8_t inputEncap) ;


-------------------------------------------------------------------------
inline uint8_t InputEncap(uint8_t inputEncap)
.........................................................................
Sets and returns the input encapsulation of the flow.
-------------------------------------------------------------------------

  inline uint8_t InputEncap(uint8_t inputEncap)
                                                                                                                
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t OutputEncap() const ;


-------------------------------------------------------------------------
inline uint8_t OutputEncap() const
.........................................................................
Returns the output encapsulation of the flow.
-------------------------------------------------------------------------

  inline uint8_t OutputEncap() const
                                       
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t OutputEncap(uint8_t outputEncap) ;


-------------------------------------------------------------------------
inline uint8_t OutputEncap(uint8_t outputEncap)
.........................................................................
Sets and returns the output encapsulation of the flow.
-------------------------------------------------------------------------

  inline uint8_t OutputEncap(uint8_t outputEncap)
                                                                                                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t PeerNextHop() const ;


-------------------------------------------------------------------------
inline ipv4addr_t PeerNextHop() const
.........................................................................
Returns the peer next hop (border router) IP address of the flow.
-------------------------------------------------------------------------

  inline ipv4addr_t PeerNextHop() const
                                       
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


ipv4addr_t PeerNextHop(ipv4addr_t peerNextHop) ;


-------------------------------------------------------------------------
inline ipv4addr_t PeerNextHop(ipv4addr_t peerNextHop)
.........................................................................
Sets and returns the peer next hop (border router) IP address of the flow.
-------------------------------------------------------------------------

  inline ipv4addr_t PeerNextHop(ipv4addr_t peerNextHop)
                                                                                                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t EngineType() const ;


-------------------------------------------------------------------------
inline uint8_t EngineType() const
.........................................................................
Returns the engine type for the flow. If set to 0, the flow did not come from a VIP adapter. If set to 1, the flow came from a IP adapter.
-------------------------------------------------------------------------

  inline uint8_t EngineType() const
                                      
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t EngineType(uint8_t engineType) ;


-------------------------------------------------------------------------
inline uint8_t EngineType(uint8_t engineType)
.........................................................................
Sets and returns the engine type for the flow. If set to 0, the flow did not come from a VIP adapter. If set to 1, the flow came from a VIP adapter.
-------------------------------------------------------------------------

  inline uint8_t EngineType(uint8_t engineType)
                                                                                                                
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t EngineId() const ;


-------------------------------------------------------------------------
inline uint8_t EngineId() const
.........................................................................
Returns the flow-export engine identifier. This is really only applicable in the presence of VIP adapters, which are capable of sending their own flows.
-------------------------------------------------------------------------

  inline uint8_t EngineId() const
                                    
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t EngineId(uint8_t engineId) ;


-------------------------------------------------------------------------
inline uint8_t EngineId(uint8_t engineId)
.........................................................................
Sets and returns the flow-export engine identifier. This is really only applicable in the presence of VIP adapters, which are capable of sending their own flows.
-------------------------------------------------------------------------

  inline uint8_t EngineId(uint8_t engineId)
                                                                                                        
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t Version() const ;


-------------------------------------------------------------------------
inline uint8_t Version() const
.........................................................................
Returns the flow-export version for the flow.
-------------------------------------------------------------------------

  inline uint8_t Version() const
                                   
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


uint8_t Version(uint8_t version) ;


-------------------------------------------------------------------------
inline uint8_t Version(uint8_t version)
.........................................................................
Sets and returns the flow-export version for the flow.
-------------------------------------------------------------------------

  inline uint8_t Version(uint8_t version)
                                                                 
;

Function is currently defined inline.


Back to the top of CflowdRawFlow


istream & Read(istream & is);


-------------------------------------------------------------------------
istream & Read(istream & is)
.........................................................................
Reads a flow from an istream. Returns the istream.
-------------------------------------------------------------------------

  istream & Read(istream & is);

Back to the top of CflowdRawFlow


int Read(int fd);


-------------------------------------------------------------------------
int Read(int fd)
.........................................................................
Reads a flow from a file descriptor. Probably more I/O efficient than Read(istream & is), since we use scatter reads. Also your only reasonable option for reading from a socket. Returns the number of bytes read on success, -1 on failure.
-------------------------------------------------------------------------

  int Read(int fd);

Back to the top of CflowdRawFlow


ostream & Write(ostream & os);


-------------------------------------------------------------------------
ostream & Write(ostream & os)
.........................................................................
Writes a flow to an ostream. Returns the ostream.
-------------------------------------------------------------------------

  ostream & Write(ostream & os);

Back to the top of CflowdRawFlow


int Write(int fd);


-------------------------------------------------------------------------
int Write(int fd)
.........................................................................
Writes a flow to a file descriptor. Probably more I/O efficient than Write(ostream & os), since we use gather writes. Also your only reasonable option for writing to a socket. Returns the number of bytes written on success, -1 on failure.
-------------------------------------------------------------------------

  int Write(int fd);

Back to the top of CflowdRawFlow


friend ostream& operator << (ostream& os, const CflowdRawFlow & flow);


-------------------------------------------------------------------------
friend ostream& operator << (ostream& os, const CflowdRawFlow & flow)
.........................................................................
Overloaded ostream '<<' operator to dump the contents of a CflowdRawFlow object to an ostream in a human-readable form. Returns the ostream.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os,
                               const CflowdRawFlow & flow);

Back to the top of CflowdRawFlow


All Members

public:
typedef uint32_t index_type;
const index_type k_routerMask = 0x00000001;
const index_type k_srcIpAddrMask = 0x00000002;
const index_type k_dstIpAddrMask = 0x00000004;
const index_type k_inputIfIndexMask = 0x00000008;
const index_type k_outputIfIndexMask = 0x00000010;
const index_type k_srcPortMask = 0x00000020;
const index_type k_dstPortMask = 0x00000040;
const index_type k_pktsMask = 0x00000080;
const index_type k_bytesMask = 0x00000100;
const index_type k_ipNextHopMask = 0x00000200;
const index_type k_startTimeMask = 0x00000400;
const index_type k_endTimeMask = 0x00000800;
const index_type k_protocolMask = 0x00001000;
const index_type k_tosMask = 0x00002000;
const index_type k_srcAsMask = 0x00004000;
const index_type k_dstAsMask = 0x00008000;
const index_type k_srcMaskLenMask = 0x00010000;
const index_type k_dstMaskLenMask = 0x00020000;
const index_type k_tcpFlagsMask = 0x00040000;
const index_type k_inputEncapMask = 0x00080000;
const index_type k_outputEncapMask = 0x00100000;
const index_type k_peerNextHopMask = 0x00200000;
const index_type k_engineTypeMask = 0x00400000;
const index_type k_engineIdMask = 0x00800000;
index_type Index() const ;
ipv4addr_t Router() const ;
ipv4addr_t Router(ipv4addr_t router) ;
ipv4addr_t SrcIpAddr() const ;
ipv4addr_t SrcIpAddr(ipv4addr_t srcIpAddr) ;
ipv4addr_t DstIpAddr() const ;
ipv4addr_t DstIpAddr(ipv4addr_t dstIpAddr) ;
uint16_t InputIfIndex() const ;
uint16_t InputIfIndex(uint16_t inputIfIndex) ;
uint16_t OutputIfIndex() const ;
uint16_t OutputIfIndex(uint16_t outputIfIndex) ;
uint16_t SrcPort() const ;
uint16_t SrcPort(uint16_t srcPort) ;
uint16_t DstPort() const ;
uint16_t DstPort(uint16_t dstPort) ;
uint32_t Pkts() const ;
uint32_t Pkts(uint32_t pkts) ;
uint32_t Bytes() const ;
uint32_t Bytes(uint32_t bytes) ;
ipv4addr_t IpNextHop() const ;
ipv4addr_t IpNextHop(ipv4addr_t ipNextHop) ;
uint32_t StartTime() const ;
uint32_t StartTime(uint32_t startTime) ;
uint32_t EndTime() const ;
uint32_t EndTime(uint32_t endTime) ;
uint8_t Protocol() const ;
uint8_t Protocol(uint8_t protocol) ;
uint8_t Tos() const ;
uint8_t Tos(uint8_t tos) ;
uint16_t SrcAs() const ;
uint16_t SrcAs(uint16_t srcAs) ;
uint16_t DstAs() const ;
uint16_t DstAs(uint16_t dstAs) ;
uint8_t SrcMaskLen() const ;
uint8_t SrcMaskLen(uint8_t srcMaskLen) ;
uint8_t DstMaskLen() const ;
uint8_t DstMaskLen(uint8_t dstMaskLen) ;
uint8_t TcpFlags() const ;
uint8_t TcpFlags(uint8_t tcpFlags) ;
uint8_t InputEncap() const ;
uint8_t InputEncap(uint8_t inputEncap) ;
uint8_t OutputEncap() const ;
uint8_t OutputEncap(uint8_t outputEncap) ;
ipv4addr_t PeerNextHop() const ;
ipv4addr_t PeerNextHop(ipv4addr_t peerNextHop) ;
uint8_t EngineType() const ;
uint8_t EngineType(uint8_t engineType) ;
uint8_t EngineId() const ;
uint8_t EngineId(uint8_t engineId) ;
uint8_t Version() const ;
uint8_t Version(uint8_t version) ;
istream & Read(istream & is);
int Read(int fd);
ostream & Write(ostream & os);
int Write(int fd);
friend ostream& operator << (ostream& os, const CflowdRawFlow & flow);
protected:

Back to the top of CflowdRawFlow


Ancestors

Class does not inherit from any other class.

Back to the top of CflowdRawFlow


Descendants

Class is not inherited by any others.

Back to the top of CflowdRawFlow


Generated from source by the Cocoon utilities on Tue Sep 22 04:08:59 1998 .

Report problems to jkotula@unimax.com

Related Objects

See https://catalog.caida.org/software/cflowd/ to explore related objects to this document in the CAIDA Resource Catalog.