3.7/slice/PropertiesAdmin_8ice_source.html

//

// 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/BuiltinSequences.ice>


#ifndef __SLICE2JAVA_COMPAT__

[["java:package:com.zeroc"]]

#endif


["objc:prefix:ICE"]

module Ice

{


dictionary<string, string> PropertyDict;


interface PropertiesAdmin

{

    string getProperty(string key);


    ["java:type:java.util.TreeMap<String, String>"] PropertyDict getPropertiesForPrefix(string prefix);


    void setProperties(PropertyDict newProperties);

}


}

BuiltinSequences.ice

Ice::PropertiesAdmin
The PropertiesAdmin interface provides remote access to the properties of a communicator.
Definition PropertiesAdmin.ice:48

Ice::PropertiesAdmin::getPropertiesForPrefix
PropertyDict getPropertiesForPrefix(string prefix)
Get all properties whose keys begin with prefix.

Ice::PropertiesAdmin::getProperty
string getProperty(string key)
Get a property by key.

Ice::PropertiesAdmin::setProperties
void setProperties(PropertyDict newProperties)
Update the communicator's properties with the given property set.

Ice
The Ice core library.
Definition BuiltinSequences.ice:27

Ice::PropertyDict
dictionary< string, string > PropertyDict
A simple collection of properties, represented as a dictionary of key/value pairs.
Definition PropertiesAdmin.ice:39