Fawkes API
Fawkes Development Version
list_message.h
1
2
/***************************************************************************
3
* plugin_list_messages.h - Fawkes Plugin Messages
4
*
5
* Created: Sat Jun 02 01:21:03 2007
6
* Copyright 2006-2007 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. A runtime exception applies to
14
* this software (see LICENSE.GPL_WRE file mentioned below for details).
15
*
16
* This program is distributed in the hope that it will be useful,
17
* but WITHOUT ANY WARRANTY; without even the implied warranty of
18
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
* GNU Library General Public License for more details.
20
*
21
* Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22
*/
23
24
#ifndef __FAWKES_PLUGIN_LIST_MESSAGE_H_
25
#define __FAWKES_PLUGIN_LIST_MESSAGE_H_
26
27
#include <plugin/net/messages.h>
28
#include <netcomm/fawkes/message_content.h>
29
30
namespace
fawkes
{
31
32
class
DynamicBuffer;
33
34
class
PluginListMessage
:
public
FawkesNetworkMessageContent
35
{
36
public
:
37
PluginListMessage
();
38
PluginListMessage
(
unsigned
int
component_id,
unsigned
int
msg_id,
39
void
*
payload
,
size_t
payload_size
);
40
virtual
~PluginListMessage
();
41
42
void
append
(
const
char
*plugin_name,
size_t
len);
43
virtual
void
serialize
();
44
45
void
reset_iterator
();
46
bool
has_next
();
47
char
*
next
();
48
49
50
private
:
51
DynamicBuffer
*plugin_list;
52
plugin_list_msg_t
msg;
53
};
54
55
}
56
57
#endif
fawkes::PluginListMessage::next
char * next()
Get next plugin from list.
Definition:
list_message.cpp:132
fawkes
Fawkes library namespace.
fawkes::PluginListMessage::~PluginListMessage
virtual ~PluginListMessage()
Destructor.
Definition:
list_message.cpp:73
fawkes::FawkesNetworkMessageContent
Fawkes network message content.
Definition:
message_content.h:32
fawkes::plugin_list_msg_t
Plugin list message.
Definition:
messages.h:94
fawkes::PluginListMessage::reset_iterator
void reset_iterator()
Reset iterator.
Definition:
list_message.cpp:110
fawkes::PluginListMessage::PluginListMessage
PluginListMessage()
Constructor.
Definition:
list_message.cpp:45
fawkes::PluginListMessage
Plugin list message.
Definition:
list_message.h:34
fawkes::PluginListMessage::serialize
virtual void serialize()
Serialize message content.
Definition:
list_message.cpp:97
fawkes::FawkesNetworkMessageContent::payload
virtual void * payload()
Return pointer to payload.
Definition:
message_content.cpp:72
fawkes::PluginListMessage::has_next
bool has_next()
Check if more list elements are available.
Definition:
list_message.cpp:121
fawkes::DynamicBuffer
Dynamically growing buffer.
Definition:
dynamic_buffer.h:46
fawkes::PluginListMessage::append
void append(const char *plugin_name, size_t len)
Append plugin name.
Definition:
list_message.cpp:90
fawkes::FawkesNetworkMessageContent::payload_size
virtual size_t payload_size()
Return payload size.
Definition:
message_content.cpp:88
src
libs
plugin
net
list_message.h
Generated by
1.8.13