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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// RMCast_Retransmission.h
//
// = AUTHOR
// Carlos O'Ryan <coryan@uci.edu>
//
// ============================================================================
#ifndef ACE_RMCAST_RETRANSMISSION_H
#define ACE_RMCAST_RETRANSMISSION_H
#include "ace/pre.h"
#include "RMCast_Module.h"
#include "RMCast_Copy_On_Write.h"
#include "ace/RB_Tree.h"
#include "ace/Synch.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
/// Store messages for retransmission in reliable configurations
/**
* Reliable configurations of the RMCast framework need to store
* messages on the sender side to resend them if one or more clients
* do not receive them successfully.
*/
class ACE_RMCast_Export ACE_RMCast_Retransmission : public ACE_RMCast_Module
{
public:
// = Initialization and termination methods.
/// Constructor
ACE_RMCast_Retransmission (void);
/// Destructor
virtual ~ACE_RMCast_Retransmission (void);
/// Use a Red-Black Tree to keep the queue of messages
typedef ACE_RB_Tree<ACE_UINT32,ACE_RMCast::Data,ACE_Less_Than<ACE_UINT32>,ACE_Null_Mutex> Collection;
typedef ACE_RB_Tree_Iterator<ACE_UINT32,ACE_RMCast::Data,ACE_Less_Than<ACE_UINT32>,ACE_Null_Mutex> Collection_Iterator;
/// The messages are stored in the Copy_On_Write wrapper to provide
/// an efficient, but thread safe interface.
typedef ACE_RMCast_Copy_On_Write<ACE_UINT32,ACE_RMCast::Data,Collection,Collection_Iterator> Messages;
/// Resend messages
/**
* Resends all the messages up to \param max_sequence_number
* Returns the number of messages sent, or -1 if there where any
* errors.
*/
int resend (ACE_UINT32 max_sequence_number);
/// Resend all messages
/**
* Resends all the messages currently in the queue.
*/
int resend_all (void);
/// Return 0 if there is no pending data to send
int has_data (void);
/// Cleanup all the stored messages
virtual int close (void);
/// Pass the message downstream, but also save it in the
/// retransmission queue
/**
* Sequence number are assigned by the ACE_RMCast_Fragmentation
* class, consequently this class first passes the message
* downstream, to obtain the sequence number and then stores the
* message for later retransmission.
*/
virtual int data (ACE_RMCast::Data &data);
/// Process an Ack message from the remote receivers.
/**
* Normally this Ack message will be a summary of all the Ack
* messages received by the ACE_RMCast_Membership class
*/
virtual int ack (ACE_RMCast::Ack &);
/// Detect when new members join the group and Ack_Join them
/**
* When a new receiver joins the group this module sends an Ack_Join
* message with the next sequence number that the receiver should
* expect.
* The sequence number is obtained from the current list of cached
* messages.
*/
virtual int join (ACE_RMCast::Join &);
/// A receiver is leaving
/**
* Normally the ACE_RMCast_Membership module could do this, but,
* because this module processes the Join messages, it seems more
* natural to process the Leave messages too.
*/
virtual int leave (ACE_RMCast::Leave &);
protected:
/// The retransmission buffer
Messages messages_;
};
#if defined (__ACE_INLINE__)
#include "RMCast_Retransmission.i"
#endif /* __ACE_INLINE__ */
#include "ace/post.h"
#endif /* ACE_RMCAST_RETRANSMISSION_H */
|
