Article Discussion Edit this page History

Grub Protocol

Contents 1 The grub Protocol 1.1 Valid Server Responces 1.1.1 WorkUnit 1.1.2 ExitProtocol 1.1.3 ClientReset 1.1.4 ExpireWorkUnits 1.1.5 ReportWorkUnits 1.1.6 ExpireWorkUnits 1.1.7 PrioritizeWorkUnits 1.1.8 ChangeGeneralWorkUnitData 1.1.9 DiscontinueModule 1.1.10 ResumeModule 1.1.11 ServerMessage 1.1.12 SyncResponse 1.2 Instruction Types 1.2.1 ClientResetInstruction 1.2.2 MessageInstruction 1.2.2.1 Type 1.2.3 ProtocolMessageInstruction 1.2.4 ExitInstruction 1.2.5 ServerUtcTimeInstruction 1.2.6 Unknown (Not really a type, it's just anything that isn't anything else) 1.2.7 PrioritizeWorkUnitsInstruction 1.2.8 ReportWorkUnitsInstruction 1.2.9 ExpireWorkUnitsInstruction 1.3 Connection errors 1.3.1 Before Connect 1.3.1.1 HTTPMedium_BAD_URL 1.3.1.2 HTTPMedium_FAILURE 1.3.1.3 HTTPMedium_CANNOT_RESOLVE 1.3.1.4 HTTPMedium_CANNOT_CONNECT 1.3.2 After Connect 1.3.2.1 HTTPMedium_BAD_USERNAME 1.3.2.2 HTTPMedium_BAD_PASSWORD 1.3.2.3 HTTPMedium_LOGIN_FAILED 1.3.2.4 HTTPMedium_BAD_HTTP 1.3.2.5 HTTPMedium_TIMEOUT 1.3.2.6 HTTPMedium_CALLBACK_ERROR 1.3.2.7 HTTPMedium_CONNECT_ABORT 1.3.2.8 HTTPMedium_CONNECT_RESET 1.4 Some Defaults

[edit] The grub Protocol

Client Connect w/ Basic Auth -> http://soap.grub.org:80/soap

USERNAME

PASSWORD (md5 hash) (HKEY_CURRENT_USER\Software\Looksmart\Grub 2\settings\userPassword)

[edit] Valid Server Responces

[edit] WorkUnit

[edit] ExitProtocol

[edit] ClientReset

[edit] ExpireWorkUnits

[edit] ReportWorkUnits

[edit] ExpireWorkUnits

[edit] PrioritizeWorkUnits

[edit] ChangeGeneralWorkUnitData

[edit] DiscontinueModule

[edit] ResumeModule

[edit] ServerMessage

[edit] SyncResponse

[edit] Instruction Types

[edit] ClientResetInstruction

Resets the client?

[edit] MessageInstruction

[edit] Type

Debug, //!< debugging message not normally slated for the user

Info, //!< something worthy of displaying to the user at the convenience

Critical, //!< something bad happened and needs prompt attention

Fatal //!< this will definately shut down the client as soon as possible

[edit] ProtocolMessageInstruction

[edit] ExitInstruction

client Should Exit?

[edit] ServerUtcTimeInstruction

Finds offset between UTC of server and system time (timezone offset)?

[edit] Unknown (Not really a type, it's just anything that isn't anything else)

This shouldn't happen.

[edit] PrioritizeWorkUnitsInstruction

[edit] ReportWorkUnitsInstruction

[edit] ExpireWorkUnitsInstruction

[edit] Connection errors

This is part of the http module that is wrapped by the soap implementation

[edit] Before Connect

[edit] HTTPMedium_BAD_URL

[edit] HTTPMedium_FAILURE

[edit] HTTPMedium_CANNOT_RESOLVE

[edit] HTTPMedium_CANNOT_CONNECT

[edit] After Connect

[edit] HTTPMedium_BAD_USERNAME

[edit] HTTPMedium_BAD_PASSWORD

[edit] HTTPMedium_LOGIN_FAILED

[edit] HTTPMedium_BAD_HTTP

[edit] HTTPMedium_TIMEOUT

[edit] HTTPMedium_CALLBACK_ERROR

[edit] HTTPMedium_CONNECT_ABORT

[edit] HTTPMedium_CONNECT_RESET

[edit] Some Defaults

DEFAULT_CONFIG_VALUE_STRING("", "DataPath", "C:\\Program Files\\Grub 2\\Data\\PersistentStorage")

DEFAULT_CONFIG_VALUE_UINT32("settings", "userCrawlInSysTray", 0)
// DEFAULT_CONFIG_VALUE_UINT32("settings", "userLocalCrawlOnly", 0)
DEFAULT_CONFIG_VALUE_STRING("settings", "userPassword", "")
DEFAULT_CONFIG_VALUE_STRING("settings", "userUsername", "")
DEFAULT_CONFIG_VALUE_STRING("settings", "userServer", "soap.grub.org")
DEFAULT_CONFIG_VALUE_UINT32("settings", "userPort", 80)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userMaxWorkUnitsAllowed", 2400)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userCpuLimitPercentage", 80)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userDownloadBandwidthLimitBytes", 1048576)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userUploadBandwidthLimitBytes", 1048576)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userDownloadMaxBandwidthAllowedBytes", 1048576)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userUploadMaxBandwidthAllowedBytes", 1048576)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userAutoUpdateMode", 0)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userRunOnlyOnSSaver", 0)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userOnStartUpMinToSysTray", 1)
DEFAULT_CONFIG_VALUE_UINT32("settings", "userStartClientOnComputerStartup", 1)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysUseCompression", 1)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysDoPrimaryProtocolExchange", 1)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysMaxProtocolRequests", 50)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysProtocolRequestSlowTime", 10)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysUtcTimeOffset", 0)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysAutoUpdateInterval", -1)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysAutoUpdater", 1)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysAutoUpdateLastRun", 0)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysFirstTimeRunning", 0)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysCheckWithAutoUpdateServLastRun", 0)
DEFAULT_CONFIG_VALUE_UINT32("settings", "sysCheckWithAutoUpdateServInterval", 86400)

DEFAULT_CONFIG_VALUE_STRING("logging", "logFileName", "C:\\Program Files\\Grub 2\\Data\\Logfiles\\grub.log")
DEFAULT_CONFIG_VALUE_UINT32("logging", "logLevel", 1)
DEFAULT_CONFIG_VALUE_UINT32("logging", "maxEventSize", 1000)
DEFAULT_CONFIG_VALUE_UINT32("logging", "maxWindowLogEventSize", 1000)
DEFAULT_CONFIG_VALUE_UINT32("logging", "flushLogOnExit", 0)

DEFAULT_CONFIG_VALUE_UINT32("scheduler", "eventCount", 0)