Ice 3.7 Slice API Reference
Instrumentation.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICE_API"]]
8 [["cpp:doxygen:include:Ice/Ice.h"]]
9 [["cpp:header-ext:h"]]
10 
11 [["ice-prefix"]]
12 
13 [["js:module:ice"]]
14 [["js:cjs-module"]]
15 
16 [["objc:dll-export:ICE_API"]]
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:Ice"]]
20 
21 #include <Ice/EndpointF.ice>
22 #include <Ice/ConnectionF.ice>
23 #include <Ice/Current.ice>
24 
25 #ifndef __SLICE2JAVA_COMPAT__
26 [["java:package:com.zeroc"]]
27 #endif
28 
29 ["objc:prefix:ICE"]
30 module Ice
31 {
32 
39 ["objc:prefix:ICEINSTRUMENTATION"]
40 module Instrumentation
41 {
42 
49 local interface Observer
50 {
57  void attach();
58 
65  void detach();
66 
74  void failed(string exceptionName);
75 }
76 
83 local enum ThreadState
84 {
91 
100 
109 
117 }
118 
126 local interface ThreadObserver extends Observer
127 {
137  void stateChanged(ThreadState oldState, ThreadState newState);
138 }
139 
145 local enum ConnectionState
146 {
153 
160 
167 
175 
183 }
184 
190 local interface ConnectionObserver extends Observer
191 {
199  void sentBytes(int num);
200 
208  void receivedBytes(int num);
209 }
210 
216 local interface DispatchObserver extends Observer
217 {
224 
232  void reply(int size);
233 }
234 
241 local interface ChildInvocationObserver extends Observer
242 {
250  void reply(int size);
251 }
252 
260 {
261 }
262 
270 {
271 }
272 
281 local interface InvocationObserver extends Observer
282 {
288  void retried();
289 
296 
312  RemoteObserver getRemoteObserver(ConnectionInfo con, Endpoint endpt, int requestId, int size);
313 
327  CollocatedObserver getCollocatedObserver(ObjectAdapter adapter, int requestId, int size);
328 }
329 
345 local interface ObserverUpdater
346 {
359 
372 }
373 
384 local interface CommunicatorObserver
385 {
401 
417 
438 
459 
475  InvocationObserver getInvocationObserver(Object* prx, string operation, Context ctx);
476 
493 
505 }
506 
507 }
508 
509 }
Ice::Instrumentation::ThreadState
ThreadState
The thread state enumeration keeps track of the different possible states of Ice threads.
Definition: Instrumentation.ice:84
Ice::Instrumentation::ChildInvocationObserver::reply
void reply(int size)
Reply notification.
Ice::ObjectAdapter
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice o...
Definition: ObjectAdapter.ice:50
Ice::Instrumentation::ThreadStateIdle
@ ThreadStateIdle
The thread is idle.
Definition: Instrumentation.ice:90
Ice::Instrumentation::CollocatedObserver
The collocated observer to instrument invocations that are collocated.
Definition: Instrumentation.ice:270
Ice::Instrumentation::DispatchObserver
The dispatch observer to instrument servant dispatch.
Definition: Instrumentation.ice:217
Ice::Instrumentation::CommunicatorObserver::getThreadObserver
ThreadObserver getThreadObserver(string parent, string id, ThreadState s, ThreadObserver o)
This method should return a thread observer for the given thread.
Ice::Instrumentation::ConnectionObserver::sentBytes
void sentBytes(int num)
Notification of sent bytes over the connection.
Ice::Instrumentation::ObserverUpdater::updateConnectionObservers
void updateConnectionObservers()
Update connection observers associated with each of the Ice connection from the communicator and its ...
Ice::Instrumentation::ConnectionStateActive
@ ConnectionStateActive
The connection is active and can send and receive messages.
Definition: Instrumentation.ice:166
Ice::Instrumentation::ObserverUpdater::updateThreadObservers
void updateThreadObservers()
Update thread observers associated with each of the Ice thread from the communicator and its object a...
Ice::Instrumentation::ThreadObserver
The thread observer interface to instrument Ice threads.
Definition: Instrumentation.ice:127
Ice::Instrumentation::ConnectionState
ConnectionState
The state of an Ice connection.
Definition: Instrumentation.ice:146
Ice::Instrumentation::InvocationObserver::userException
void userException()
Notification of a user exception.
Ice::Instrumentation::ConnectionObserver
The connection observer interface to instrument Ice connections.
Definition: Instrumentation.ice:191
Ice::ConnectionInfo
Base class providing access to the connection details.
Definition: Connection.ice:64
Ice::Instrumentation::ChildInvocationObserver
The child invocation observer to instrument remote or collocated invocations.
Definition: Instrumentation.ice:242
Ice::Instrumentation::ConnectionStateClosed
@ ConnectionStateClosed
The connection is closed and waits for potential dispatch to be finished before being destroyed and d...
Definition: Instrumentation.ice:182
Ice::Instrumentation::RemoteObserver
The remote observer to instrument invocations that are sent over the wire.
Definition: Instrumentation.ice:260
Ice::Instrumentation::ConnectionStateHolding
@ ConnectionStateHolding
The connection is holding the reception of new messages.
Definition: Instrumentation.ice:159
Ice::Instrumentation::ThreadStateInUseForIO
@ ThreadStateInUseForIO
The thread is in use performing reads or writes for Ice connections.
Definition: Instrumentation.ice:99
Ice::Instrumentation::ConnectionStateValidating
@ ConnectionStateValidating
The connection is being validated.
Definition: Instrumentation.ice:152
Ice::Instrumentation::CommunicatorObserver
The communicator observer interface used by the Ice run-time to obtain and update observers for its o...
Definition: Instrumentation.ice:385
Ice::Instrumentation::InvocationObserver::retried
void retried()
Notification of the invocation being retried.
Ice::Instrumentation::Observer
The object observer interface used by instrumented objects to notify the observer of their existence.
Definition: Instrumentation.ice:50
Ice::Instrumentation::CommunicatorObserver::getConnectionEstablishmentObserver
Observer getConnectionEstablishmentObserver(Endpoint endpt, string connector)
This method should return an observer for the given endpoint information and connector.
Ice::Instrumentation::ConnectionStateClosing
@ ConnectionStateClosing
The connection is being gracefully shutdown and waits for the peer to close its end of the connection...
Definition: Instrumentation.ice:174
Ice::Instrumentation::CommunicatorObserver::getConnectionObserver
ConnectionObserver getConnectionObserver(ConnectionInfo c, Endpoint e, ConnectionState s, ConnectionObserver o)
This method should return a connection observer for the given connection.
Ice::Instrumentation::DispatchObserver::userException
void userException()
Notification of a user exception.
Ice::Instrumentation::ThreadStateInUseForUser
@ ThreadStateInUseForUser
The thread is calling user code (servant implementation, AMI callbacks).
Definition: Instrumentation.ice:108
Ice::Instrumentation::ConnectionObserver::receivedBytes
void receivedBytes(int num)
Notification of received bytes over the connection.
Ice::Endpoint
The user-level interface to an endpoint.
Definition: Endpoint.ice:163
Ice::Instrumentation::InvocationObserver
The invocation observer to instrument invocations on proxies.
Definition: Instrumentation.ice:282
Ice::Instrumentation::Observer::attach
void attach()
This method is called when the instrumented object is created or when the observer is attached to an ...
ConnectionF.ice
Ice::Instrumentation::Observer::failed
void failed(string exceptionName)
Notification of a failure.
Ice::Instrumentation::Observer::detach
void detach()
This method is called when the instrumented object is destroyed and as a result the observer detached...
Ice
The Ice core library.
Definition: BuiltinSequences.ice:27
Ice::Instrumentation::CommunicatorObserver::getDispatchObserver
DispatchObserver getDispatchObserver(Current c, int size)
This method should return a dispatch observer for the given dispatch.
Ice::Instrumentation::DispatchObserver::reply
void reply(int size)
Reply notification.
Current.ice
Ice::Instrumentation::ObserverUpdater
The observer updater interface.
Definition: Instrumentation.ice:346
Ice::Instrumentation::InvocationObserver::getCollocatedObserver
CollocatedObserver getCollocatedObserver(ObjectAdapter adapter, int requestId, int size)
Get a collocated observer for this invocation.
Ice::Instrumentation::ThreadObserver::stateChanged
void stateChanged(ThreadState oldState, ThreadState newState)
Notification of thread state change.
Ice::Instrumentation::CommunicatorObserver::setObserverUpdater
void setObserverUpdater(ObserverUpdater updater)
The Ice run-time calls this method when the communicator is initialized.
Ice::Current
Information about the current method invocation for servers.
Definition: Current.ice:103
Ice::Instrumentation::ThreadStateInUseForOther
@ ThreadStateInUseForOther
The thread is performing other internal activities (DNS lookups, timer callbacks, etc).
Definition: Instrumentation.ice:116
Ice::Instrumentation::InvocationObserver::getRemoteObserver
RemoteObserver getRemoteObserver(ConnectionInfo con, Endpoint endpt, int requestId, int size)
Get a remote observer for this invocation.
Ice::Instrumentation::CommunicatorObserver::getEndpointLookupObserver
Observer getEndpointLookupObserver(Endpoint endpt)
This method should return an observer for the given endpoint information.
Ice::Context
dictionary< string, string > Context
A request context.
Definition: Current.ice:42
Ice::Instrumentation::CommunicatorObserver::getInvocationObserver
InvocationObserver getInvocationObserver(Object *prx, string operation, Context ctx)
This method should return an invocation observer for the given invocation.
EndpointF.ice