Network::Service Class Reference

Inheritance diagram for Network::Service:

Public Types
typedef ProcID	ID
enum	ServType {   ODGui , ODBatchGui , ODBatch , ODTest ,   Python , Other }
typedef Batch::ID	SubID
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	Service (const Authority &)
	Service (const OD::JSON::Object &)
	Service (PortNr_Type, const char *hostnm=nullptr)
	~Service ()
BufferString	address () const
void	fillJSON (OD::JSON::Object &) const
Authority	getAuthority () const
ID	getID () const
SubID	getSubID () const
bool	isAlive () const
bool	isBatch () const
bool	isEmpty () const
bool	isOK () const
bool	isPortValid () const
BufferString	lockFnm () const
BufferString	logFnm () const
uiRetVal	message () const
bool	operator!= (const Service &) const
bool	operator== (const Service &) const
ProcID	PID () const
PortNr_Type	port () const
void	printInfo (const char *ky=nullptr, od_ostream *=nullptr) const
void	setAuthority (const Authority &)
void	setEmpty ()
void	setHostName (const char *)
void	setLogFile (const char *)
void	setLogFile (const FilePath &)
void	setPID (const OS::CommandLauncher &)
void	setPID (ProcID)
void	setPort (PortNr_Type)
void	setType (ServType typ)
void	setViewOnly (bool yn=true)
void	stop (bool removelog=true)
ServType	type () const
BufferString	url () const
uiRetVal	useJSON (const OD::JSON::Object &)
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

Static Public Member Functions
static ID	getID (const OD::JSON::Object &)
static BufferString	getServiceName (const OD::JSON::Object &)
static const char *	sKeyLogFile ()
static const char *	sKeyPID ()
static const char *	sKeyServiceName ()
static const char *	sKeyServiceType ()
static const char *	sKeySubID ()

Private Member Functions
void	init ()
	mOD_DisableCopy (Service)

Private Attributes
Authority	auth_
FilePath *	logfp_ = nullptr
uiRetVal	msg_
ProcID	pid_ = 0
SubID	subid_ = Batch::JobDispatcher::getInvalid()
ServType	type_
bool	viewonly_ = false

Additional Inherited Members
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

<>

Member Typedef Documentation

ID

typedef ProcID Network::Service::ID

SubID

typedef Batch::ID Network::Service::SubID

Member Enumeration Documentation

ServType

enum Network::Service::ServType

Enumerator
ODGui
ODBatchGui
ODBatch
ODTest
Python
Other

Constructor & Destructor Documentation

Service() [1/3]

Network::Service::Service	(	PortNr_Type	,
		const char *	hostnm = nullptr
	)

Service() [2/3]

Network::Service::Service

(

const Authority &

)

Service() [3/3]

Network::Service::Service

(

const OD::JSON::Object &

)

~Service()

Network::Service::~Service

(

)

Member Function Documentation

address()

BufferString Network::Service::address

(

)

const

fillJSON()

void Network::Service::fillJSON

(

OD::JSON::Object &

)

const

getAuthority()

Authority Network::Service::getAuthority ( ) const

inline

getID() [1/2]

ID Network::Service::getID

(

)

const

getID() [2/2]

static ID Network::Service::getID ( const OD::JSON::Object &  )

static

getServiceName()

static BufferString Network::Service::getServiceName ( const OD::JSON::Object &  )

static

getSubID()

SubID Network::Service::getSubID ( ) const

inline

init()

void Network::Service::init ( )

private

isAlive()

bool Network::Service::isAlive

(

)

const

isBatch()

bool Network::Service::isBatch

(

)

const

isEmpty()

bool Network::Service::isEmpty

(

)

const

isOK()

bool Network::Service::isOK

(

)

const

isPortValid()

bool Network::Service::isPortValid

(

)

const

lockFnm()

BufferString Network::Service::lockFnm

(

)

const

logFnm()

BufferString Network::Service::logFnm

(

)

const

message()

uiRetVal Network::Service::message ( ) const

inline

mOD_DisableCopy()

Network::Service::mOD_DisableCopy ( Service  )

private

operator!=()

bool Network::Service::operator!=

(

const Service &

)

const

operator==()

bool Network::Service::operator==

(

const Service &

)

const

PID()

ProcID Network::Service::PID ( ) const

inline

port()

PortNr_Type Network::Service::port

(

)

const

printInfo()

void Network::Service::printInfo	(	const char *	ky = nullptr,
		od_ostream *	= nullptr
	)		const

setAuthority()

void Network::Service::setAuthority

(

const Authority &

)

setEmpty()

void Network::Service::setEmpty

(

)

setHostName()

void Network::Service::setHostName

(

const char *

)

setLogFile() [1/2]

void Network::Service::setLogFile

(

const char *

)

setLogFile() [2/2]

void Network::Service::setLogFile

(

const FilePath &

)

setPID() [1/2]

void Network::Service::setPID

(

const OS::CommandLauncher &

)

setPID() [2/2]

void Network::Service::setPID

(

ProcID

)

setPort()

void Network::Service::setPort

(

PortNr_Type

)

setType()

void Network::Service::setType ( ServType  typ )

inline

setViewOnly()

void Network::Service::setViewOnly ( bool  yn = true )

inline

sKeyLogFile()

static const char* Network::Service::sKeyLogFile ( )

inlinestatic

sKeyPID()

static const char* Network::Service::sKeyPID ( )

inlinestatic

sKeyServiceName()

static const char* Network::Service::sKeyServiceName ( )

inlinestatic

sKeyServiceType()

static const char* Network::Service::sKeyServiceType ( )

inlinestatic

sKeySubID()

static const char* Network::Service::sKeySubID ( )

static

stop()

void Network::Service::stop

(

bool

removelog = true

)

type()

ServType Network::Service::type ( ) const

inline

url()

BufferString Network::Service::url

(

)

const

useJSON()

uiRetVal Network::Service::useJSON

(

const OD::JSON::Object &

)

Member Data Documentation

auth_

Authority Network::Service::auth_

private

logfp_

FilePath* Network::Service::logfp_ = nullptr

private

msg_

uiRetVal Network::Service::msg_

mutableprivate

pid_

ProcID Network::Service::pid_ = 0

private

subid_

SubID Network::Service::subid_ = Batch::JobDispatcher::getInvalid()

private

type_

ServType Network::Service::type_

private

viewonly_

bool Network::Service::viewonly_ = false

private