Ice 3.7 Slice API Reference
Loading...
Searching...
No Matches
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"]
30module Ice
31{
32
39["objc:prefix:ICEINSTRUMENTATION"]
41{
42
49local interface Observer
50{
57 void attach();
58
65 void detach();
66
74 void failed(string exceptionName);
75}
76
118
126local interface ThreadObserver extends Observer
127{
137 void stateChanged(ThreadState oldState, ThreadState newState);
138}
139
184
190local interface ConnectionObserver extends Observer
191{
199 void sentBytes(int num);
200
208 void receivedBytes(int num);
209}
210
216local interface DispatchObserver extends Observer
217{
224
232 void reply(int size);
233}
234
241local interface ChildInvocationObserver extends Observer
242{
250 void reply(int size);
251}
252
260{
261}
262
270{
271}
272
281local 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
345local interface ObserverUpdater
346{
359
372}
373
506
507}
508
509}
Base class providing access to the connection details.
Definition Connection.ice:64
The user-level interface to an endpoint.
Definition Endpoint.ice:163
The child invocation observer to instrument remote or collocated invocations.
Definition Instrumentation.ice:242
void reply(int size)
Reply notification.
The collocated observer to instrument invocations that are collocated.
Definition Instrumentation.ice:270
The communicator observer interface used by the Ice run-time to obtain and update observers for its o...
Definition Instrumentation.ice:385
Observer getEndpointLookupObserver(Endpoint endpt)
This method should return an observer for the given endpoint information.
Observer getConnectionEstablishmentObserver(Endpoint endpt, string connector)
This method should return an observer for the given endpoint information and connector.
ConnectionObserver getConnectionObserver(ConnectionInfo c, Endpoint e, ConnectionState s, ConnectionObserver o)
This method should return a connection observer for the given connection.
ThreadObserver getThreadObserver(string parent, string id, ThreadState s, ThreadObserver o)
This method should return a thread observer for the given thread.
InvocationObserver getInvocationObserver(Object *prx, string operation, Context ctx)
This method should return an invocation observer for the given invocation.
void setObserverUpdater(ObserverUpdater updater)
The Ice run-time calls this method when the communicator is initialized.
DispatchObserver getDispatchObserver(Current c, int size)
This method should return a dispatch observer for the given dispatch.
The connection observer interface to instrument Ice connections.
Definition Instrumentation.ice:191
void receivedBytes(int num)
Notification of received bytes over the connection.
void sentBytes(int num)
Notification of sent bytes over the connection.
The dispatch observer to instrument servant dispatch.
Definition Instrumentation.ice:217
void reply(int size)
Reply notification.
void userException()
Notification of a user exception.
The invocation observer to instrument invocations on proxies.
Definition Instrumentation.ice:282
void retried()
Notification of the invocation being retried.
CollocatedObserver getCollocatedObserver(ObjectAdapter adapter, int requestId, int size)
Get a collocated observer for this invocation.
void userException()
Notification of a user exception.
RemoteObserver getRemoteObserver(ConnectionInfo con, Endpoint endpt, int requestId, int size)
Get a remote observer for this invocation.
The observer updater interface.
Definition Instrumentation.ice:346
void updateConnectionObservers()
Update connection observers associated with each of the Ice connection from the communicator and its ...
void updateThreadObservers()
Update thread observers associated with each of the Ice thread from the communicator and its object a...
The object observer interface used by instrumented objects to notify the observer of their existence.
Definition Instrumentation.ice:50
void detach()
This method is called when the instrumented object is destroyed and as a result the observer detached...
void attach()
This method is called when the instrumented object is created or when the observer is attached to an ...
void failed(string exceptionName)
Notification of a failure.
The remote observer to instrument invocations that are sent over the wire.
Definition Instrumentation.ice:260
The thread observer interface to instrument Ice threads.
Definition Instrumentation.ice:127
void stateChanged(ThreadState oldState, ThreadState newState)
Notification of thread state change.
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice o...
Definition ObjectAdapter.ice:50
The Instrumentation local interfaces enable observing a number of Ice core internal components (threa...
Definition Instrumentation.ice:41
ConnectionState
The state of an Ice connection.
Definition Instrumentation.ice:146
@ ConnectionStateHolding
The connection is holding the reception of new messages.
Definition Instrumentation.ice:159
@ ConnectionStateActive
The connection is active and can send and receive messages.
Definition Instrumentation.ice:166
@ ConnectionStateClosing
The connection is being gracefully shutdown and waits for the peer to close its end of the connection...
Definition Instrumentation.ice:174
@ ConnectionStateClosed
The connection is closed and waits for potential dispatch to be finished before being destroyed and d...
Definition Instrumentation.ice:182
@ ConnectionStateValidating
The connection is being validated.
Definition Instrumentation.ice:152
ThreadState
The thread state enumeration keeps track of the different possible states of Ice threads.
Definition Instrumentation.ice:84
@ ThreadStateInUseForOther
The thread is performing other internal activities (DNS lookups, timer callbacks, etc).
Definition Instrumentation.ice:116
@ ThreadStateIdle
The thread is idle.
Definition Instrumentation.ice:90
@ ThreadStateInUseForIO
The thread is in use performing reads or writes for Ice connections.
Definition Instrumentation.ice:99
@ ThreadStateInUseForUser
The thread is calling user code (servant implementation, AMI callbacks).
Definition Instrumentation.ice:108
The Ice core library.
Definition BuiltinSequences.ice:27
dictionary< string, string > Context
A request context.
Definition Current.ice:42
Information about the current method invocation for servers.
Definition Current.ice:103