Connection.ice

Go to the documentation of this file.

//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
 
#pragma once
 
[["cpp:dll-export:ICE_API"]]
[["cpp:doxygen:include:Ice/Ice.h"]]
[["cpp:header-ext:h"]]
 
[["ice-prefix"]]
 
[["js:module:ice"]]
[["js:cjs-module"]]
 
[["objc:dll-export:ICE_API"]]
[["objc:header-dir:objc"]]
 
[["python:pkgdir:Ice"]]
 
#include <Ice/ObjectAdapterF.ice>
#include <Ice/Identity.ice>
#include <Ice/Endpoint.ice>
 
#ifndef __SLICE2JAVA_COMPAT__
[["java:package:com.zeroc"]]
#endif
 
["objc:prefix:ICE"]
module Ice
{

["cpp:scoped", "objc:scoped"]
local enum CompressBatch
{
    Yes,

    No,

    BasedOnProxy
}
 
#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
local class ConnectionInfo
{
    ConnectionInfo underlying;

    bool incoming;

    string adapterName;

    string connectionId;
}
#endif
 
local interface Connection;

["delegate"]
local interface CloseCallback
{
    ["swift:noexcept"] void closed(Connection con);
}

["delegate"]
local interface HeartbeatCallback
{
    ["swift:noexcept"] void heartbeat(Connection con);
}

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

local enum ACMHeartbeat
{
    HeartbeatOff,
    HeartbeatOnDispatch,
    HeartbeatOnIdle,
    HeartbeatAlways
}

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

["cpp:scoped", "objc:scoped"]
local enum ConnectionClose
{
    Forcefully,
    Gracefully,
    GracefullyWithWait
}
 
#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
["swift:inherits:Swift.CustomStringConvertible"]
local interface Connection
{
    ["cpp:noexcept", "js:async"] void close(ConnectionClose mode);

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

    void setAdapter(ObjectAdapter adapter);

    ["cpp:const", "cpp:noexcept", "swift:noexcept"] ObjectAdapter getAdapter();

    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Endpoint getEndpoint();

    ["async-oneway"] void flushBatchRequests(CompressBatch compress);

    void setCloseCallback(CloseCallback callback);

    ["swift:noexcept"] void setHeartbeatCallback(HeartbeatCallback callback);

    ["async-oneway"] void heartbeat();

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

    ["cpp:noexcept", "swift:noexcept"] ACM getACM();

    ["cpp:const", "cpp:noexcept", "swift:noexcept"] string type();

    ["cpp:const", "cpp:noexcept", "swift:noexcept"] int timeout();

    ["cpp:const", "cpp:noexcept", "swift:noexcept"] string toString();

    ["cpp:const", "swift:nonnull"] ConnectionInfo getInfo();

    void setBufferSize(int rcvSize, int sndSize);

    ["cpp:const"] void throwException();
}

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

    int localPort = -1;

    string remoteAddress = "";

    int remotePort = -1;
}

local class TCPConnectionInfo extends IPConnectionInfo
{
    int rcvSize = 0;

    int sndSize = 0;
}

local class UDPConnectionInfo extends IPConnectionInfo
{
    string mcastAddress;

    int mcastPort = -1;

    int rcvSize = 0;

    int sndSize = 0;
}

dictionary<string, string> HeaderDict;

local class WSConnectionInfo extends ConnectionInfo
{
    HeaderDict headers;
}
 
#endif
 
}