Sirikata
Namespaces | Defines | Enumerations | Functions
libcore/include/sirikata/core/options/CommonOptions.hpp File Reference
#include <sirikata/core/util/Platform.hpp>
Include dependency graph for CommonOptions.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  Sirikata
 

Note: All the classes provided in this file are thin wrappers around the corresponding classes in ASIO.


Defines

#define OPT_CRASHREPORT_URL   "crashreport"
#define OPT_PLUGINS   "plugins"
#define OPT_EXTRA_PLUGINS   "extra-plugins"
#define OPT_LOG_FILE   "log-file"
#define OPT_LOG_ALL_TO_FILE   "log-all-to-file"
#define OPT_DAEMON   "daemon"
#define OPT_PID_FILE   "pid-file"
#define OPT_SST_DEFAULT_WINDOW_SIZE   "sst.default-window-size"
#define STATS_TRACE_FILE   "stats.trace-filename"
#define PROFILE   "profile"
#define OPT_REGION_WEIGHT   "region-weight"
#define OPT_REGION_WEIGHT_ARGS   "region-weight-args"
#define OPT_CDN_HOST   "cdn.host"
#define OPT_CDN_SERVICE   "cdn.service"
#define OPT_CDN_DNS_URI_PREFIX   "cdn.dns.prefix"
#define OPT_CDN_DOWNLOAD_URI_PREFIX   "cdn.download.prefix"
#define OPT_CDN_UPLOAD_URI_PREFIX   "cdn.upload.prefix"
#define OPT_CDN_UPLOAD_STATUS_URI_PREFIX   "cdn.upload.status.prefix"
#define OPT_TRACE_TIMESERIES   "trace.timeseries"
#define OPT_TRACE_TIMESERIES_OPTIONS   "trace.timeseries-options"
#define OPT_COMMAND_COMMANDER   "command.commander"
#define OPT_COMMAND_COMMANDER_OPTIONS   "command.commander-options"

Enumerations

enum  Sirikata::UnregisteredOptionBehavior { Sirikata::AllowUnregisteredOptions, Sirikata::FailOnUnregisteredOptions }

Functions

SIRIKATA_FUNCTION_EXPORT void Sirikata::ReportVersion ()
 Report version information to the log.
SIRIKATA_FUNCTION_EXPORT void Sirikata::InitOptions ()
SIRIKATA_FUNCTION_EXPORT void Sirikata::ParseOptions (int argc, char **argv, UnregisteredOptionBehavior unreg=FailOnUnregisteredOptions)
SIRIKATA_FUNCTION_EXPORT void Sirikata::ParseOptionsFile (const String &fname, bool required=true, UnregisteredOptionBehavior unreg=FailOnUnregisteredOptions)
SIRIKATA_FUNCTION_EXPORT void Sirikata::ParseOptions (int argc, char **argv, const String &config_file_option, UnregisteredOptionBehavior unreg=FailOnUnregisteredOptions)
 Parse command line options and config files, ensuring the command line arguments take priority but reading the config file from an option rather than hard coding it.
SIRIKATA_FUNCTION_EXPORT void Sirikata::FakeParseOptions ()
SIRIKATA_FUNCTION_EXPORT void Sirikata::FillMissingOptionDefaults ()
 Fills in default values, used after initial parsing to make sure we don't block overriding option values from a secondary source (e.g.
SIRIKATA_FUNCTION_EXPORT void Sirikata::DaemonizeAndSetOutputs ()
 Daemonizes the process if requested and then sets up output, e.g.
SIRIKATA_FUNCTION_EXPORT void Sirikata::DaemonCleanup ()
SIRIKATA_FUNCTION_EXPORT
OptionValue * 
Sirikata::GetOption (const char *name)
SIRIKATA_FUNCTION_EXPORT
OptionValue * 
Sirikata::GetOption (const char *klass, const char *name)
template<typename T >
Sirikata::GetOptionValue (const char *name)
template<typename T >
Sirikata::GetOptionValue (const char *klass, const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT String Sirikata::GetOptionValue< String > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT Vector3f Sirikata::GetOptionValue< Vector3f > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT
Vector3ui32 
Sirikata::GetOptionValue< Vector3ui32 > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT
BoundingBox3f 
Sirikata::GetOptionValue< BoundingBox3f > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT
ObjectHostID 
Sirikata::GetOptionValue< ObjectHostID > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT
Task::DeltaTime 
Sirikata::GetOptionValue< Task::DeltaTime > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT uint32 Sirikata::GetOptionValue< uint32 > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT int32 Sirikata::GetOptionValue< int32 > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT uint64 Sirikata::GetOptionValue< uint64 > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT int64 Sirikata::GetOptionValue< int64 > (const char *name)
template<>
SIRIKATA_FUNCTION_EXPORT bool Sirikata::GetOptionValue< bool > (const char *name)
SIRIKATA_FUNCTION_EXPORT String Sirikata::GetPerServerString (const String &orig, const ServerID &sid)
SIRIKATA_FUNCTION_EXPORT String Sirikata::GetPerServerFile (const char *opt_name, const ServerID &sid)
 Get an option which is a filename and modify it to be server specific.
SIRIKATA_FUNCTION_EXPORT String Sirikata::GetPerServerFile (const char *opt_name, const ObjectHostID &ohid)

Define Documentation

#define OPT_CDN_DNS_URI_PREFIX   "cdn.dns.prefix"

Referenced by Sirikata::InitOptions().

#define OPT_CDN_DOWNLOAD_URI_PREFIX   "cdn.download.prefix"

Referenced by Sirikata::InitOptions().

#define OPT_CDN_HOST   "cdn.host"

Referenced by Sirikata::InitOptions().

#define OPT_CDN_SERVICE   "cdn.service"

Referenced by Sirikata::InitOptions().

#define OPT_CDN_UPLOAD_STATUS_URI_PREFIX   "cdn.upload.status.prefix"

Referenced by Sirikata::InitOptions().

#define OPT_CDN_UPLOAD_URI_PREFIX   "cdn.upload.prefix"

Referenced by Sirikata::InitOptions().

#define OPT_COMMAND_COMMANDER   "command.commander"

Referenced by Sirikata::InitOptions(), and main().

#define OPT_COMMAND_COMMANDER_OPTIONS   "command.commander-options"

Referenced by Sirikata::InitOptions(), and main().

#define OPT_CRASHREPORT_URL   "crashreport"

Referenced by Sirikata::InitOptions().

#define OPT_DAEMON   "daemon"
#define OPT_EXTRA_PLUGINS   "extra-plugins"

Referenced by Sirikata::InitOptions(), and main().

#define OPT_LOG_ALL_TO_FILE   "log-all-to-file"
#define OPT_LOG_FILE   "log-file"
#define OPT_PID_FILE   "pid-file"
#define OPT_PLUGINS   "plugins"

Referenced by Sirikata::InitOptions(), and main().

#define OPT_REGION_WEIGHT   "region-weight"
#define OPT_REGION_WEIGHT_ARGS   "region-weight-args"
#define OPT_SST_DEFAULT_WINDOW_SIZE   "sst.default-window-size"

Referenced by Sirikata::InitOptions().

#define OPT_TRACE_TIMESERIES   "trace.timeseries"

Referenced by Sirikata::InitOptions(), and main().

#define OPT_TRACE_TIMESERIES_OPTIONS   "trace.timeseries-options"

Referenced by Sirikata::InitOptions(), and main().

#define PROFILE   "profile"

Referenced by Sirikata::InitOptions(), and main().

#define STATS_TRACE_FILE   "stats.trace-filename"

Referenced by Sirikata::InitOptions(), and main().