Connection.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", "js:ice-build"]]

#include <Ice/ObjectAdapterF.ice>
#include <Ice/Identity.ice>
#include <Ice/Endpoint.ice>

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

local class ConnectionInfo
{
    bool incoming;

    string adapterName;

    string connectionId;

    int rcvSize;

    int sndSize;
};

local interface Connection;

local interface ConnectionCallback
{
    void heartbeat(Connection con);

    void closed(Connection con);
};

local enum ACMClose
{
    CloseOff,
    CloseOnIdle,
    CloseOnInvocation,
    CloseOnInvocationAndIdle,
    CloseOnIdleForceful
};

local enum ACMHeartbeat
{
    HeartbeatOff,
    HeartbeatOnInvocation,
    HeartbeatOnIdle,
    HeartbeatAlways
};

local struct ACM
{
    int timeout;
    ACMClose close;
    ACMHeartbeat heartbeat;
};

local interface Connection
{
    void close(bool force);

    ["cpp:const"] Object* createProxy(Identity id);

    void setAdapter(ObjectAdapter adapter);

    ["cpp:const"] ObjectAdapter getAdapter();

    ["cpp:const"] Endpoint getEndpoint();

    ["async"] void flushBatchRequests();

    void setCallback(ConnectionCallback callback);

    ["java:optional"]
    void setACM(optional(1) int timeout, optional(2) ACMClose close, optional(3) ACMHeartbeat heartbeat);

    ACM getACM();

    ["cpp:const"] string type();

    ["cpp:const"] int timeout();

    ["cpp:const"] string toString();

    ["cpp:const"] ConnectionInfo getInfo();

    void setBufferSize(int rcvSize, int sndSize);
};

local class IPConnectionInfo extends ConnectionInfo
{
    string localAddress = "";

    int localPort = -1;

    string remoteAddress = "";

    int remotePort = -1;
};

local class TCPConnectionInfo extends IPConnectionInfo
{
};

local class UDPConnectionInfo extends IPConnectionInfo
{
    string mcastAddress;

    int mcastPort = -1;
};

dictionary<string, string> HeaderDict;

local class WSConnectionInfo extends TCPConnectionInfo
{
    HeaderDict headers;
};

};