Fawkes API
Fawkes Development Version
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
All
Classes
Namespaces
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Groups
Pages
processor.cpp
1
2
/***************************************************************************
3
* processor.cpp - Fawkes RefBox Processor Pure Virtual Class
4
*
5
* Created: Sun Apr 19 19:15:46 2009 (German Open 2009)
6
* Copyright 2009 Tim Niemueller [www.niemueller.de]
7
*
8
****************************************************************************/
9
10
/* This program is free software; you can redistribute it and/or modify
11
* it under the terms of the GNU General Public License as published by
12
* the Free Software Foundation; either version 2 of the License, or
13
* (at your option) any later version.
14
*
15
* This program is distributed in the hope that it will be useful,
16
* but WITHOUT ANY WARRANTY; without even the implied warranty of
17
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
* GNU Library General Public License for more details.
19
*
20
* Read the full text in the LICENSE.GPL file in the doc directory.
21
*/
22
23
#include "processor.h"
24
25
/** @class RefBoxProcessor "processor/processor.h"
26
* Referee Box Communication Processor.
27
* Classes that implement this interface communicate with a refbox and provide
28
* information received to a RefBoxStateHandler.
29
* @author Tim Niemueller
30
*
31
* @fn bool RefBoxProcessor::check_connection()
32
* Check if the connection is alive and reconnect.
33
* If the connection is not alive the processor shall do a single attempt
34
* to reestablish the connection.
35
* @return true if the connection is established or could be recovered, false
36
* otherwise.
37
*
38
* @fn void RefBoxProcessor::refbox_process()
39
* Process incoming refbox communication.
40
* This shall process a (limited number of) communication packets received
41
* from the particular refbox at hand.
42
*/
43
44
/** Pure virtual destructor. */
45
RefBoxProcessor::~RefBoxProcessor
()
46
{
47
}
48
49
/** Set handler.
50
* @param rsh Ref box state handler used to process incoming information
51
*/
52
void
53
RefBoxProcessor::set_handler
(
RefBoxStateHandler
*rsh)
54
{
55
_rsh
= rsh;
56
}
src
plugins
refboxcomm
processor
processor.cpp
Generated by
1.8.3.1