CCommandLineArgs Class Reference

#include <CCommandLineArgs.h>

Public Types
enum	{ kInvalidPort = -1 }
enum	{ kInvalidTimeValue = -1 }
enum	SessionSupportTimeoutType { kTimeoutSessionIdle, kTimeoutReceiveIdle, kSSTimeoutUnknown }

Public Member Functions
	CCommandLineArgs ()
virtual	~CCommandLineArgs ()
virtual void	Terminate ()
virtual int32	GetArgCnt ()
virtual const PMString &	GetNthArg (const int32 &nth)
virtual int	GetPortNumber ()
virtual int	GetAdminPortNumber ()
virtual bool	ShouldCreateConsole ()
virtual PMString	GetConfigurationName ()
virtual const PMString &	GetExecutablePath ()
virtual int32	GetMaxErrors ()
virtual void	SetMaxErrors (int32 newMaxErrors)
virtual bool	ShouldPostToErrorList ()
virtual void	SetPostToErrorList (bool16 bShouldPost)
virtual bool	ShouldUseSEH ()
virtual bool	ArePreviewsOn ()
virtual PMString	GetHomeFolder ()
virtual PMString	GetPluginPath ()
virtual PMString	GetIORFile ()
virtual PMString	GetHostName ()
virtual bool	ShouldLogToSystemEventLog ()
virtual bool	ShouldSendCrashLogs ()
virtual int	GetSessionSupportTimeout (SessionSupportTimeoutType type)
virtual int	GetHeartbeatUpdateInterval ()
virtual bool	ExecuteOnMainThreadOnly ()
virtual bool	IsSessionSupportNonBlocking ()
virtual uint16	GetMaximumWaitForBeginSession ()
virtual bool	ProcessArgs ()
virtual bool	ProcessArgsEarly ()
virtual bool	ProcessArgsLate ()
virtual void	ShowUsage ()
virtual bool	GetUseVersionCue ()

Protected Member Functions
virtual IDFile	MakeFileInSemaphoreFolder (const PMString &filename)

Protected Attributes
std::vector< PMString >	fArgs

Detailed Description

Class for the server that parses and provides access to the command line paramters. Command line parameters are accessed through the global variable named gCommandLineArgs, which is an object of this type.

Constructor & Destructor Documentation

CCommandLineArgs::CCommandLineArgs

(

)

Internal use only

virtual CCommandLineArgs::~CCommandLineArgs ( )

virtual

Internal use only

Member Function Documentation

virtual bool CCommandLineArgs::ArePreviewsOn ( )

virtual

Returns whether previews should be generated for placed images or not.

virtual bool CCommandLineArgs::ExecuteOnMainThreadOnly ( )

virtual

Returns

true if all incoming soap requests should be executed on main thread

virtual int CCommandLineArgs::GetAdminPortNumber ( )

virtual

Return the admin port number.

virtual int32 CCommandLineArgs::GetArgCnt ( )

virtual

Returns the number of command line arguments.

virtual PMString CCommandLineArgs::GetConfigurationName ( )

virtual

Return the configuration name.

virtual const PMString& CCommandLineArgs::GetExecutablePath ( )

virtual

Return the executable path.

virtual int CCommandLineArgs::GetHeartbeatUpdateInterval ( )

virtual

Returns

interval at which last active timestamp of IDS is sent to IDS console

virtual PMString CCommandLineArgs::GetHomeFolder ( )

virtual

Returns the home folder.

virtual PMString CCommandLineArgs::GetHostName ( )

virtual

Return the host name

virtual PMString CCommandLineArgs::GetIORFile ( )

virtual

Return the name absolute pathname of the CORBA IOR file. The IOR for the application object will be written to this file.

virtual int32 CCommandLineArgs::GetMaxErrors ( )

virtual

Return the maximum number of errors stored in the SOAP server's in-memory error capture list.

virtual uint16 CCommandLineArgs::GetMaximumWaitForBeginSession ( )

virtual

Returns

maximum wait time in secs for begin session to take place in case of non-blocking begin session requests

virtual const PMString& CCommandLineArgs::GetNthArg ( const int32 &  nth )

virtual

Get the nth command line argument. This is the raw arguments passed in on the command line. Plug-in developers can use this to access their own arguments.

virtual PMString CCommandLineArgs::GetPluginPath ( )

virtual

Returns the plugin path specified on the command line. Plug-ins are loaded from this path in addition to the regular search paths.

virtual int CCommandLineArgs::GetPortNumber ( )

virtual

Return the port number.

virtual int CCommandLineArgs::GetSessionSupportTimeout ( SessionSupportTimeoutType  type )

virtual

Returns the timeout of specified type for Session Support functionality

virtual bool CCommandLineArgs::GetUseVersionCue ( )

virtual

Return kTrue if Version Cue was requested.

virtual bool CCommandLineArgs::IsSessionSupportNonBlocking ( )

virtual

Returns

true if a BeginSession() request should be non blocking

virtual bool CCommandLineArgs::ProcessArgs ( )

inlinevirtual

Internal use only

virtual void CCommandLineArgs::SetMaxErrors ( int32  newMaxErrors )

virtual

Sets the maximum number of errors stored in the SOAP server's in-memory error capture list. Use of this method may override what was originally set on the command line.

virtual void CCommandLineArgs::SetPostToErrorList ( bool16  bShouldPost )

virtual

Sets whether errors should be posted to the error list interface or not.

virtual bool CCommandLineArgs::ShouldCreateConsole ( )

virtual

Return whether to create a console window or not. No-op on Macintosh.

virtual bool CCommandLineArgs::ShouldLogToSystemEventLog ( )

virtual

Returns whether errors should be logged to the system services log.

virtual bool CCommandLineArgs::ShouldPostToErrorList ( )

virtual

Returns whether errors should be posted to the error list interface or not.

virtual bool CCommandLineArgs::ShouldSendCrashLogs ( )

virtual

Returns whether crash logs should be sent to Adobe (there is no UI either way)

virtual bool CCommandLineArgs::ShouldUseSEH ( )

virtual

Returns whether structured event handling should be used on Windows or not.

virtual void CCommandLineArgs::ShowUsage ( )

virtual

Write abbreviated usage text to the terminal window

virtual void CCommandLineArgs::Terminate ( )

virtual

Internal use only