blob: 4bcab3d5589ac80cf01c13671a532b04c0ab20e2 (
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
|
// -*- C++ -*-
//=============================================================================
/**
* @file Flushing_Strategy.h
*
* $Id$
*
* @author Carlos O'Ryan <coryan@uci.edu>
*/
//=============================================================================
#ifndef TAO_FLUSHING_STRATEGY_H
#define TAO_FLUSHING_STRATEGY_H
#include /**/ "ace/pre.h"
#include "tao/orbconf.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Time_Value;
ACE_END_VERSIONED_NAMESPACE_DECL
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
class TAO_Transport;
class TAO_Queued_Message;
/**
* @class TAO_Flushing_Strategy
*
* @brief Define the interface for the flushing strategy, i.e. the
* algorithm that controls how does the ORB flush outgoing
* data.
*
* Please read the documentation in the TAO_Transport class to find
* out more about the design of the outgoing data path.
*
* Some applications can block the current thread whenever they are
* sending out data. In those cases they can obtain better
* performance by blocking in calls to write() than by participating
* in the Leader/Followers protocol to shared the ORB Reactor.
*
* This strategy controls how does the ORB schedule and cancel
* reactive I/O, if there is no reactive I/O the strategy is just a
* no-op.
*
*/
class TAO_Flushing_Strategy
{
public:
/// Destructor
virtual ~TAO_Flushing_Strategy (void);
enum SCHEDULE_OUTPUT_RETURN { MUST_FLUSH = -2 };
/// Schedule the transport argument to be flushed
/// If -2 is returned then the caller must call one of
/// the flush_* methods.
/// If -1 is returned then there was an error.
/// If 0 is returned then the flush was scheduled successfully.
virtual int schedule_output (TAO_Transport *transport) = 0;
/// Cancel all scheduled output for the transport argument
virtual int cancel_output (TAO_Transport *transport) = 0;
/// Wait until msg is sent out. Potentially other messages are
/// flushed too, for example, because there are ahead in the queue.
virtual int flush_message (TAO_Transport *transport,
TAO_Queued_Message *msg,
ACE_Time_Value *max_wait_time) = 0;
/// Wait until the transport has no messages queued.
virtual int flush_transport (TAO_Transport *transport, ACE_Time_Value *max_wait_time) = 0;
};
TAO_END_VERSIONED_NAMESPACE_DECL
#include /**/ "ace/post.h"
#endif /* TAO_FLUSHING_STRATEGY_H */
|
