facebook::fb303::FacebookServiceIf Class Reference

#include <FacebookService.h>

Inheritance diagram for facebook::fb303::FacebookServiceIf:

Public Member Functions
virtual void	getName (std::string &_return)=0
virtual void	getVersion (std::string &_return)=0
virtual fb_status::type	getStatus ()=0
virtual void	getStatusDetails (std::string &_return)=0
virtual void	getCounters (std::map< std::string, int64_t > &_return)=0
virtual int64_t	getCounter (const std::string &key)=0
virtual void	setOption (const std::string &key, const std::string &value)=0
virtual void	getOption (std::string &_return, const std::string &key)=0
virtual void	getOptions (std::map< std::string, std::string > &_return)=0
virtual void	getCpuProfile (std::string &_return, const int32_t profileDurationInSec)=0
virtual int64_t	aliveSince ()=0
virtual void	reinitialize ()=0
virtual void	shutdown ()=0

Detailed Description

Standard base service

Member Function Documentation

aliveSince()

virtual int64_t facebook::fb303::FacebookServiceIf::aliveSince ( )

pure virtual

Returns the unix time that the server has been running since

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getCounter()

virtual int64_t facebook::fb303::FacebookServiceIf::getCounter ( const std::string &  key )

pure virtual

Gets the value of a single counter

Parameters

key

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getCounters()

virtual void facebook::fb303::FacebookServiceIf::getCounters ( std::map< std::string, int64_t > &  _return )

pure virtual

Gets the counters for this service

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getCpuProfile()

virtual void facebook::fb303::FacebookServiceIf::getCpuProfile ( std::string &  _return, const int32_t  profileDurationInSec  )

pure virtual

Returns a CPU profile over the given time interval (client and server must agree on the profile format).

Parameters

profileDurationInSec

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getName()

virtual void facebook::fb303::FacebookServiceIf::getName ( std::string &  _return )

pure virtual

Returns a descriptive name of the service

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getOption()

virtual void facebook::fb303::FacebookServiceIf::getOption ( std::string &  _return, const std::string &  key  )

pure virtual

Gets an option

Parameters

key

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getOptions()

virtual void facebook::fb303::FacebookServiceIf::getOptions ( std::map< std::string, std::string > &  _return )

pure virtual

Gets all options

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getStatus()

virtual fb_status::type facebook::fb303::FacebookServiceIf::getStatus ( )

pure virtual

Gets the status of this service

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getStatusDetails()

virtual void facebook::fb303::FacebookServiceIf::getStatusDetails ( std::string &  _return )

pure virtual

User friendly description of status, such as why the service is in the dead or warning state, or what is being started or stopped.

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

getVersion()

virtual void facebook::fb303::FacebookServiceIf::getVersion ( std::string &  _return )

pure virtual

Returns the version of the service

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

reinitialize()

virtual void facebook::fb303::FacebookServiceIf::reinitialize ( )

pure virtual

Tell the server to reload its configuration, reopen log files, etc

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

setOption()

virtual void facebook::fb303::FacebookServiceIf::setOption ( const std::string &  key, const std::string &  value  )

pure virtual

Sets an option

Parameters

key
value

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

shutdown()

virtual void facebook::fb303::FacebookServiceIf::shutdown ( )

pure virtual

Suggest a shutdown to the server

Implemented in facebook::fb303::FacebookServiceNull, facebook::fb303::FacebookServiceClient, facebook::fb303::FacebookServiceMultiface, and facebook::fb303::FacebookServiceConcurrentClient.

---

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

• iceberg/catalog/hive/gen-cpp/FacebookService.h