Instrumentation.ice

Go to the documentation of this file.

// **********************************************************************
//
// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

#pragma once

[["cpp:header-ext:h", "objc:header-dir:objc"]]

#include <Ice/EndpointF.ice>
#include <Ice/ConnectionF.ice>
#include <Ice/Current.ice>

["objc:prefix:ICE"]
module Ice
{

["objc:prefix:ICEINSTRUMENTATION"]
module Instrumentation
{

local interface Observer
{
    void attach();

    void detach();

    void failed(string exceptionName);
};

local enum ThreadState
{
    ThreadStateIdle,

    ThreadStateInUseForIO,

    ThreadStateInUseForUser,

    ThreadStateInUseForOther,
};

local interface ThreadObserver extends Observer
{
    void stateChanged(ThreadState oldState, ThreadState newState);
};

local enum ConnectionState
{
    ConnectionStateValidating,

    ConnectionStateHolding,

    ConnectionStateActive,

    ConnectionStateClosing,

    ConnectionStateClosed
};


local interface ConnectionObserver extends Observer
{
    void sentBytes(int num);

    void receivedBytes(int num);
};

local interface DispatchObserver extends Observer
{
    void userException();

    void reply(int size);
};

local interface ChildInvocationObserver extends Observer
{
    void reply(int size);
};


local interface RemoteObserver extends ChildInvocationObserver
{
};

local interface CollocatedObserver extends ChildInvocationObserver
{
};

local interface InvocationObserver extends Observer
{
    void retried();

    void userException();

    RemoteObserver getRemoteObserver(ConnectionInfo con, Endpoint endpt, int requestId, int size);

    CollocatedObserver getCollocatedObserver(ObjectAdapter adapter, int requestId, int size);
};

local interface ObserverUpdater
{
    void updateConnectionObservers();

    void updateThreadObservers();
};

local interface CommunicatorObserver
{
    Observer getConnectionEstablishmentObserver(Endpoint endpt, string connector);

    Observer getEndpointLookupObserver(Endpoint endpt);

    ConnectionObserver getConnectionObserver(ConnectionInfo c, Endpoint e, ConnectionState s, ConnectionObserver o);

    ThreadObserver getThreadObserver(string parent, string id, ThreadState s, ThreadObserver o);

    InvocationObserver getInvocationObserver(Object* prx, string operation, Context ctx);

    DispatchObserver getDispatchObserver(Current c, int size);

    void setObserverUpdater(ObserverUpdater updater);
};

};

};