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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
// -*- C++ -*-
// ===================================================================
/**
* @file Service_Context.h
*
* $Id$
*
* @author Balachandran Natarajan <bala@cs.wustl.edu>
*/
// ===================================================================
#ifndef TAO_SERVICE_CONTEXT_H
#define TAO_SERVICE_CONTEXT_H
#include /**/ "ace/pre.h"
#include "tao/IOPC.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
namespace TAO
{
namespace CSD
{
class FW_Server_Request_Wrapper;
}
}
/**
* @class TAO_Service_Context
*
* @brief Helper class for managing the service context list
* information.
*
* This class is used to manipulate and access the service context
* list that is passed around with every GIOP request/reply. The
* definition of the service context list is simply a sequence of the
* following structures:
* typedef unsigned long ServiceId;
* struct ServiceContext
* {
* ServiceId context_id;
* sequence <octet> context_data;
* };
* typedef sequence <ServiceContext> ServiceContextList;
*
* the real motivation behind this class is to consolidate all the
* marshalling and unmarshalling information pertaining to service
* context list
*
* @note Somewhere down the line we may want to use this class for
* fast access to the info that we need from the Service Context
* List.
*/
class TAO_Export TAO_Service_Context
{
public:
/// Declare FW_Server_Request_Wrapper a friend
/// This friendship makes the FW_Server_Request_Wrapper be able to
/// clone the TAO_Service_Context data member in TAO_ServerRequest.
friend class TAO::CSD::FW_Server_Request_Wrapper;
/// Constructor
TAO_Service_Context (void);
/// = Generic components
/// Insert the component into the list, making a copy of the octet
/// sequence.
void set_context (const IOP::ServiceContext &context);
/// Insert the component into the list, making a copy of the octet
/// sequence. Search the list before insertion so that the
/// insertion does not cause a duplicate context to be in the list.
/// If the replace flag is true, update the specified context.
/// Return 0 if the component was present and the replace flag
/// was not set to true.
int set_context (const IOP::ServiceContext &context, CORBA::Boolean replace);
/// Insert the component into the list, but efficiently stealing the
/// contents of the octet sequence.
void set_context (IOP::ServiceContext &context);
/// Get a copy of the context identified by <context.context_id>, return
/// 0 if the component is not present.
int get_context (IOP::ServiceContext &context) const;
/// Get a reference to a context identified by id, return
/// 0 if the component is not present.
int get_context (IOP::ServiceId id, const IOP::ServiceContext **context) const;
/// Get a copy of the Service Context corresponding to the given
/// ServiceId. The caller owns the returned Service Context.
/**
* @return 0 If a Service Context with the given ServiceId doesn't
* exist.
*/
int get_context (IOP::ServiceId id, IOP::ServiceContext_out context);
/// Set the context from the CDR stream and add that to the service
/// Context list
void set_context (IOP::ServiceId id, TAO_OutputCDR &cdr);
/// Set the context from the CDR stream and return the context back
/// to the caller. *Does not* modify the underlying service context
/// list.
void set_context (IOP::ServiceContext &context, TAO_OutputCDR &cdr);
/// Is the @a id available in the underlying service context list? If
/// so return true, else return false
bool is_service_id (IOP::ServiceId id);
/// = Marshaling and demarshaling the list
int encode (TAO_OutputCDR& cdr) const;
int decode (TAO_InputCDR& cdr);
/// Return the underlying service context list
IOP::ServiceContextList &service_info (void);
/// @note This method is only for backward comptiblity. We
/// need to get this removed once RT folks have their service
/// addition info done through this interface
const IOP::ServiceContextList &service_info (void) const;
private:
/// Helper methods to implement set_context()
void set_context_i (const IOP::ServiceContext &context);
void set_context_i (IOP::ServiceContext &context);
void add_context_i (const IOP::ServiceContext &context);
void add_context_i (IOP::ServiceContext &context);
void set_context_i (IOP::ServiceId id, TAO_OutputCDR &cdr);
void set_context_i (IOP::ServiceContext &context, TAO_OutputCDR &cdr);
/// Helper methods to implement get_context()
int get_context_i (IOP::ServiceContext &context) const;
// Prevent copying
TAO_Service_Context (const TAO_Service_Context &);
TAO_Service_Context &operator= (const TAO_Service_Context &);
private:
/// The ServiceContextList info.
IOP::ServiceContextList service_context_;
};
TAO_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
# include "tao/Service_Context.inl"
#endif /* ! __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* TAO_SERVICE_CONTEXT_H */
|
