blob: 4f42f6f9e89702d79ca6552fdd63c1157ad46a7a (
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
|
/**
* @file sender.h
*
* @brief Interface of sender_t.
*
*/
/*
* Copyright (C) 2005-2007 Martin Willi
* Copyright (C) 2005 Jan Hutter
* Hochschule fuer Technik Rapperswil
*
* This program 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 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* 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.
*/
#ifndef SENDER_H_
#define SENDER_H_
typedef struct sender_t sender_t;
#include <library.h>
#include <network/packet.h>
/**
* @brief Thread responsible for sending packets over the socket.
*
* @b Constructors:
* - sender_create()
*
* @ingroup threads
*/
struct sender_t {
/**
* @brief Send a packet over the network.
*
* This function is non blocking and adds the packet to a queue.
* Whenever the sender thread things it's good to send the packet,
* it'll do so.
*
* @param this calling object
* @param packet packet to send
*/
void (*send) (sender_t *this, packet_t *packet);
/**
* @brief Destroys a sender object.
*
* @param this calling object
*/
void (*destroy) (sender_t *this);
};
/**
* @brief Create the sender thread.
*
* The thread will start to work, getting packets
* from its queue and sends them out.
*
* @return created sender object
*
* @ingroup threads
*/
sender_t * sender_create(void);
#endif /*SENDER_H_*/
|
