icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::FileParserPrx:

Collaboration diagram for IceGrid::FileParserPrx:

Public Member Functions
ApplicationDescriptor	parse (const ::std::string &xmlFile, const ::std::shared_ptr< AdminPrx > &adminProxy, const ::Ice::Context &context=::Ice::noExplicitContext)
	Parse a file. More...

::std::function< void()>	parseAsync (const ::std::string &xmlFile, const ::std::shared_ptr< AdminPrx > &adminProxy, ::std::function< void(::IceGrid::ApplicationDescriptor)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Parse a file. More...

template<template< typename > class P = ::std::promise>
auto	parseAsync (const ::std::string &xmlFile, const ::std::shared_ptr< AdminPrx > &adminProxy, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ApplicationDescriptor >>().get_future())
	Parse a file. More...

Public Member Functions inherited from Ice::Proxy< FileParserPrx, ::Ice::ObjectPrx >
::std::shared_ptr< FileParserPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr< FileParserPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< FileParserPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< FileParserPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< FileParserPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...

::std::shared_ptr< FileParserPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< FileParserPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr< FileParserPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr< FileParserPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< FileParserPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr< FileParserPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< FileParserPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr< FileParserPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...

::std::shared_ptr< FileParserPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< FileParserPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr< FileParserPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< FileParserPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< FileParserPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< FileParserPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr< FileParserPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< FileParserPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...

::std::shared_ptr< FileParserPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface. More...

Detailed Description

icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceGrid::FileParserPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ parse()

ApplicationDescriptor IceGrid::FileParserPrx::parse	(	const ::std::string &	xmlFile,
		const ::std::shared_ptr< AdminPrx > &	adminProxy,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Parse a file.

Parameters

xmlFile	Full pathname to the file.
adminProxy	An Admin proxy, used only to retrieve default templates when needed. May be null.
context	The Context map to send with the invocation.

Returns: The application descriptor.

Exceptions

IceGrid::ParseException Raised if an error occurred during parsing.

◆ parseAsync() [1/2]

::std::function<void()> IceGrid::FileParserPrx::parseAsync	(	const ::std::string &	xmlFile,
		const ::std::shared_ptr< AdminPrx > &	adminProxy,
		::std::function< void(::IceGrid::ApplicationDescriptor)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Parse a file.

Parameters

xmlFile	Full pathname to the file.
adminProxy	An Admin proxy, used only to retrieve default templates when needed. May be null.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ parseAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::FileParserPrx::parseAsync	(	const ::std::string &	xmlFile,
		const ::std::shared_ptr< AdminPrx > &	adminProxy,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::IceGrid::ApplicationDescriptor>>().get_future())

inline

Parse a file.

Parameters

xmlFile	Full pathname to the file.
adminProxy	An Admin proxy, used only to retrieve default templates when needed. May be null.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

The documentation for this class was generated from the following file:

generated/cpp11/x64/Release/IceGrid/FileParser.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ice_staticId()

◆ parse()

◆ parseAsync() [1/2]

◆ parseAsync() [2/2]