/usr/include/omniORB4/IOP_S.h is in libomniorb4-dev 4.1.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 160 161 162 163 164 165 166 167 168 169 170 | // -*- Mode: C++; -*-
// Package : omniORB2
// IOP_S.h Created on: 05/01/2001
// Author : Sai Lai Lo (sll)
//
// Copyright (C) 2001 AT&T Laboratories Cambridge
//
// This file is part of the omniORB library
//
// The omniORB library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library 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
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free
// Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA
//
//
// Description:
// *** PROPRIETORY INTERFACE ***
//
/*
$Log$
Revision 1.1.2.4 2001/09/20 11:30:59 sll
On the server, the final state of a GIOP_S is ReplyCompleted instead of
Idle. This is necessary because the idle connection management code
treats Idle as a state where the idle counter can be restarted.
Revision 1.1.2.3 2001/09/10 17:41:30 sll
Added WaitForRequestHeader in IOP_S::State. Reorder the enum labels inside
IOP_S::State, any label that is larger than WaitForRequestHeader now
indicates that the IOP_S is actively processing a request.
Revision 1.1.2.2 2001/05/02 14:20:15 sll
Make sure that getStream() is used instead of casting to get a cdrStream
from a IOP_C and IOP_S.
Revision 1.1.2.1 2001/04/18 17:26:29 sll
Big checkin with the brand new internal APIs.
*/
#ifndef __IOP_S_H__
#define __IOP_S_H__
class omniCallDescriptor;
OMNI_NAMESPACE_BEGIN(omni)
////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////
class IOP_S {
public:
IOP_S() {}
virtual ~IOP_S() {}
virtual cdrStream& getStream() = 0;
virtual const char* operation_name() const = 0;
enum State { UnUsed,
Idle,
Zombie,
WaitForRequestHeader,
RequestHeaderIsBeingProcessed,
RequestIsBeingProcessed,
WaitingForReply,
ReplyIsBeingComposed,
ReplyCompleted,
InputFullyBuffered,
InputPartiallyBuffered
};
// A IOP_S instance operates in one of the following states:
//
// Idle - no request has been received
// RequestIsBeingProcessed - a request is being processed, arguments
// can be unmarshalled from the
// cdrStream
// WaitingForReply - An upcall has been dispatched into
// the object implementation
// ReplyIsBeingComposed - a reply is being composed, results
// can be marshalled into the
// cdrStream
// Zombie - the destructor has been called
//
// Calling the member functions RequestReceived(), InitialiseReply() and
// ReplyCompleted() cause the IOP_S to change state. The state transitions
// are as follows:
//
// +------------+
// | | ~IOP_S()
// +----+---+ |
// | Zombie |<-------+
// +--------+
// ^
// | ~IOP_S()
// pd_response_expected && |
// ReplyCompleted() +----+---+ <dispatcher() got a valid
// +---------------->| Idle |---------------+ request>
// | +--------+ |
// | ^ V
// +-----------------------+ | +--------------------------+
// | ReplyIsBeingComposed | | | RequestIsBeingProcessed |
// +-----------------------+ | +-----------------+--------+
// ^ | !pd_response_expected && |
// | | ReplyCompleted() |
// | +--------------------+ |
// +---------| WaitingForReply |<------------------+
// InitialiseReply() +--------------------+ RequestReceived()
//
//
// The dispatcher() encapsulates the upcall to the stub level dispatcher
// with a try block that catches all system exceptions. The exception
// handlers deal with an exception according to the state of the IOP_S
// at the time:
//
// 1. If a system exception is caught when arguments are unmarshalled or
// results are marshalled, i.e. the IOP_S is either in
// RequestIsBeingProcessed or ReplyIsBeingComposed,
// something is seriously wrong in the marshalling or unmarshalling
// and cannot recover without destroying the strand. The destructor
// is called with the state unchanged.
//
// 2. If a system exception is caught while the strand is in
// WaitingForReply, the dispatcher() would completed internally the
// reply sequence and propagate the exception back to the client.
//
// The destructor examines the state, if it is *not* in Idle, there is
// something seriously wrong with the cdrStream. Also the state
// of the strand, on which the cdrStream is built, is unknown.
// For this reason, the strand is marked as dying by the destructor. The
// destructor may be called multiple times. It simply returns if the instance
// is already in Zombie state.
//
// Calling the member functions RequestReceived(), InitialiseReply() and
// ReplyCompleted() while the IOP_S is not in the appropriate state as
// indicated above would cause a CORBA::INTERNAL() exception to be raised.
//
virtual void ReceiveRequest(omniCallDescriptor&) = 0;
virtual void SkipRequestBody() = 0;
virtual void SendReply() = 0;
virtual void SendException(CORBA::Exception* value) = 0;
private:
IOP_S(const IOP_S&);
IOP_S& operator=(const IOP_S&);
operator cdrStream& ();
// This is to make sure that we do not have any code that blindly cast
// a reference to this object to a cdrStream&. All code should use
// getStream() instead.
};
OMNI_NAMESPACE_END(omni)
#endif // __IOP_S_H__
|