Skip To Content ArcGIS for Developers Sign In Dashboard

LocalService Class

(Esri::ArcGISRuntime::LocalService)

The base class for local service classes. More...

Header: #include <LocalService>
Inherits: Object
Inherited By:

Esri::ArcGISRuntime::LocalGeoprocessingService and Esri::ArcGISRuntime::LocalMapService

Public Functions

~LocalService()
QString name() const
QString packagePath() const
void start()
LocalServerStatus status() const
void stop()
virtual QUrl url() const
  • 31 public functions inherited from QObject

Signals

void statusChanged()

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The base class for local service classes.

Note: Local server is only available on Windows and Linux.

Member Function Documentation

LocalService::~LocalService()

Destructor.

QString LocalService::name() const

Returns the name of the service.

QString LocalService::packagePath() const

Returns the package path of the service.

void LocalService::start()

Starts the service on the local server asynchronously.

Monitor the statusChanged signal to wait for startup to complete or fail. Ensure that the local service is started before using the service.

LocalServerStatus LocalService::status() const

Returns the status of the service.

[signal] void LocalService::statusChanged()

Signal emitted when the status changes.

void LocalService::stop()

Stops the service asynchronously.

Monitor the statusChanged signal to wait for the service to stop.

[virtual] QUrl LocalService::url() const

Returns the URL of the service.


Feedback on this topic?