summaryrefslogtreecommitdiff
path: root/cesar/maximus/ethernet/inc/IEthernet.h
blob: b5b6a44b19d0a961f5634f01ead985c4283513fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/************************************************************************
                        IEthernet.h - Copyright buret

Here you can write a license for your code, some comments or any other
information you want to have in your generated code. To to this simply
configure the "headings" directory in uml to point to a directory
where you have your heading files.

or you can just replace the contents of this file with your own.
If you want to do this, this file is located at

/usr/share/apps/umbrello/headings/heading.h

-->Code Generators searches for heading files based on the file extension
   i.e. it will look for a file name ending in ".h" to include in C++ header
   files, and for a file name ending in ".java" to include in all generated
   java code.
   If you name the file "heading.<extension>", Code Generator will always
   choose this file even if there are other files with the same extension in the
   directory. If you name the file something else, it must be the only one with that
   extension in the directory to guarantee that Code Generator will choose it.

you can use variables in your heading files which are replaced at generation
time. possible variables are : author, date, time, filename and filepath.
just write %variable_name%

This file was generated on %date% at %time%
The original location of this file is /home/buret/eclipse/maximus/common/interfaces/IEthernet.h
**************************************************************************/

#ifndef IETHERNET_H
#define IETHERNET_H

#include "system_types.h" // for 'File_Descriptor'

#include <boost/function.hpp> // for 'EtherCb'

class EtherSciMsg;

typedef boost::function <void (EtherSciMsg &)> EtherCb;


/**
  * class IEthernet
  */

class IEthernet
{

public:

  // Constructors/Destructors
  //  

  /**
   * Empty Constructor
   */
  IEthernet ( ) { }

  /**
   * Empty Destructor
   */
  virtual ~IEthernet ( ) { }
  
  // public methods
  //  

  /**
   * Initializes Ethernet with an interface callback function for Ether SCI message reception.
   * @param  interface_cb
   * @return bool
   */
  virtual bool init ( EtherCb interface_cb ) = 0;

  /**
   * Creates an Ether SCI message.
   * @return EtherSciMsg *
   */
  virtual EtherSciMsg * createEther ( ) = 0;

  /**
   * Sends an Ether SCI message.
   * This message has to be configured before transmission.
   * @param  ether_sci_msg
   * @return bool
   */
  virtual bool sendEther ( EtherSciMsg & ether_sci_msg ) = 0;

  /**
   * Called when an Ether SCI message is received.
   * @param  ether_sci_msg
   * @return bool
   */
  virtual bool receiveEther ( EtherSciMsg & ether_sci_msg ) = 0;

  /**
   * Creates a TAP.
   * @param  dev  name of the TAP file
   * @return the created TAP file descriptor
   */
  virtual File_Descriptor allocTap ( char * dev ) const = 0;
};


#endif // IETHERNET_H