Common and Utilities - Constants

Definitions


#include <dwc.h>

#define   DWC_COMMONSTR_MAX_KEY_VALUE_LEN         4096

enum DWCError {
    DWC_ERROR_NONE                           0
    DWC_ERROR_DS_MEMORY_ANY
    DWC_ERROR_AUTH_ANY
    DWC_ERROR_AUTH_OUT_OF_SERVICE
    DWC_ERROR_AUTH_STOP_SERVICE
    DWC_ERROR_AC_ANY
    DWC_ERROR_NETWORK
    DWC_ERROR_GHTTP_ANY
    DWC_ERROR_DISCONNECTED
    DWC_ERROR_FATAL
    DWC_ERROR_FRIENDS_SHORTAGE
    DWC_ERROR_NOT_FRIEND_SERVER
    DWC_ERROR_SERVER_FULL
    DWC_ERROR_ND_ANY
    DWC_ERROR_ND_HTTP
    DWC_ERROR_SVL_ANY
    DWC_ERROR_SVL_HTTP
    DWC_ERROR_PROF_PARSEERR
    DWC_ERROR_PROF_HTTP
    DWC_ERROR_DB_ANY
    DWC_ERROR_SC_CONNECT_BLOCK
    DWC_ERROR_NETWORK_LIGHT
    DWC_ERROR_NUM
};

enum DWCErrorType {
    DWC_ETYPE_NO_ERROR                       0
    DWC_ETYPE_LIGHT
    DWC_ETYPE_SHOW_ERROR
    DWC_ETYPE_SHUTDOWN_FM
    DWC_ETYPE_SHUTDOWN_GHTTP
    DWC_ETYPE_SHUTDOWN_ND
    DWC_ETYPE_DISCONNECT
    DWC_ETYPE_FATAL
    DWC_ETYPE_NUM
};

enum  {
    DWC_ECODE_SEQ_LOGIN                      (-60000)
    DWC_ECODE_SEQ_FRIEND                     (-70000)
    DWC_ECODE_SEQ_MATCH                      (-80000)
    DWC_ECODE_SEQ_ETC                        (-90000)
    DWC_ECODE_GS_GP                           (-1000)
    DWC_ECODE_GS_PERS                         (-2000)
    DWC_ECODE_GS_STATS                        (-3000)
    DWC_ECODE_GS_QR2                          (-4000)
    DWC_ECODE_GS_SB                           (-5000)
    DWC_ECODE_GS_NN                           (-6000)
    DWC_ECODE_GS_GT2                          (-7000)
    DWC_ECODE_GS_HTTP                         (-8000)
    DWC_ECODE_GS_ETC                          (-9000)
    DWC_ECODE_TYPE_NETWORK                     ( -10)
    DWC_ECODE_TYPE_SERVER                      ( -20)
    DWC_ECODE_TYPE_DNS                         ( -30)
    DWC_ECODE_TYPE_DATA                        ( -40)
    DWC_ECODE_TYPE_SOCKET                      ( -50)
    DWC_ECODE_TYPE_BIND                        ( -60)
    DWC_ECODE_TYPE_TIMEOUT                     ( -70)
    DWC_ECODE_TYPE_PEER                        ( -80)
    DWC_ECODE_TYPE_CONN_OVER                   (-100)
    DWC_ECODE_TYPE_STATS_AUTH                  (-200)
    DWC_ECODE_TYPE_STATS_LOAD                  (-210)
    DWC_ECODE_TYPE_STATS_SAVE                  (-220)
    DWC_ECODE_TYPE_NOT_FRIEND                  (-400)
    DWC_ECODE_TYPE_OTHER                       (-410)
    DWC_ECODE_TYPE_MUCH_FAILURE                (-420)
    DWC_ECODE_TYPE_SC_CL_FAIL                  (-430)
    DWC_ECODE_TYPE_CLOSE                       (-600)
    DWC_ECODE_TYPE_TRANS_HEADER                (-610)
    DWC_ECODE_TYPE_TRANS_BODY                  (-620)
    DWC_ECODE_TYPE_TRANS_SEND                  (-630)
    DWC_ECODE_TYPE_TRANS_UNKNOWN_PEER          (-640)
    DWC_ECODE_TYPE_AC_FATAL                    (-700)
    DWC_ECODE_TYPE_OPEN_FILE                   (-800)
    DWC_ECODE_TYPE_INVALID_POST                (-810)
    DWC_ECODE_TYPE_REQ_INVALID                 (-820)
    DWC_ECODE_TYPE_UNSPECIFIED                 (-830)
    DWC_ECODE_TYPE_BUFF_OVER                   (-840)
    DWC_ECODE_TYPE_PARSE_URL                   (-850)
    DWC_ECODE_TYPE_BAD_RESPONSE                (-860)
    DWC_ECODE_TYPE_REJECTED                    (-870)
    DWC_ECODE_TYPE_FILE_RW                     (-880)
    DWC_ECODE_TYPE_INCOMPLETE                  (-890)
    DWC_ECODE_TYPE_TO_BIG                      (-900)
    DWC_ECODE_TYPE_ENCRYPTION                  (-910)
    DWC_ECODE_TYPE_ALLOC                         (-1)
    DWC_ECODE_TYPE_PARAM                         (-2)
    DWC_ECODE_TYPE_SO_SOCKET                     (-3)
    DWC_ECODE_TYPE_NOT_INIT                      (-4)
    DWC_ECODE_TYPE_DUP_INIT                      (-5)
    DWC_ECODE_TYPE_WM_INIT                       (-6)
    DWC_ECODE_TYPE_UNEXPECTED                    (-9)
    DWC_ECODE_SEQ_ADDINS                       (-30000)
    DWC_ECODE_FUNC_PROF                        (-3000)
    DWC_ECODE_FUNC_ND                          (-1000)
    DWC_ECODE_TYPE_ND_ALLOC                    ( -1)
    DWC_ECODE_TYPE_ND_FATAL                    ( -9)
    DWC_ECODE_TYPE_ND_STATE                    (-10)
    DWC_ECODE_TYPE_ND_HTTP                     (-20)
    DWC_ECODE_TYPE_ND_PARAM                    (-30)
    DWC_ECODE_TYPE_ND_CANCEL                   (-40)
    DWC_ECODE_TYPE_ND_SERVER_PARAM             (-101)
    DWC_ECODE_TYPE_ND_SERVER_SERVICE           (-102)
    DWC_ECODE_TYPE_ND_SERVER_INVALIDTOKEN      (-103)
    DWC_ECODE_TYPE_ND_SERVER_TOKENEXPIRED      (-104)
    DWC_ECODE_TYPE_ND_SERVER_NOCONTENTS        (-105)
    DWC_ECODE_TYPE_ND_SERVER_ATTR              (-106)
    DWC_ECODE_TYPE_ND_SERVER_CONTENTSEXPIRED   (-107)
    DWC_ECODE_TYPE_ND_SERVER_INVALIDAP         (-108)
    DWC_ECODE_TYPE_ND_SERVER_DATABASE          (-109)
    DWC_ECODE_TYPE_ND_SERVER_PASSWORD          (-110)
    DWC_ECODE_TYPE_PROF_CONNERR                ( -10)
    DWC_ECODE_TYPE_PROF_PARSEERR               ( -20)
    DWC_ECODE_TYPE_PROF_OTHERERR               ( -30)
};

enum DWCAUTHSERVER {
    DWC_AUTHSERVER_DEBUG                     0
    DWC_AUTHSERVER_RELEASE
    DWC_AUTHSERVER_TEST
};

enum DWCReportFlag {
    DWC_REPORTFLAG_NONE                      0x00000000
    DWC_REPORTFLAG_INFO                      0x00000001
    DWC_REPORTFLAG_ERROR                     0x00000002
    DWC_REPORTFLAG_DEBUG                     0x00000004
    DWC_REPORTFLAG_WARNING                   0x00000008
    DWC_REPORTFLAG_ACHECK                    0x00000010
    DWC_REPORTFLAG_LOGIN                     0x00000020
    DWC_REPORTFLAG_MATCH_NN                  0x00000040
    DWC_REPORTFLAG_MATCH_GT2                 0x00000080
    DWC_REPORTFLAG_TRANSPORT                 0x00000100
    DWC_REPORTFLAG_QR2_REQ                   0x00000200
    DWC_REPORTFLAG_SB_UPDATE                 0x00000400
    DWC_REPORTFLAG_SEND_INFO                 0x00008000
    DWC_REPORTFLAG_RECV_INFO                 0x00010000
    DWC_REPORTFLAG_UPDATE_SV                 0x00020000
    DWC_REPORTFLAG_CONNECTINET               0x00040000
    DWC_REPORTFLAG_AUTH                      0x01000000
    DWC_REPORTFLAG_AC                        0x02000000
    DWC_REPORTFLAG_BM                        0x04000000
    DWC_REPORTFLAG_UTIL                      0x08000000
    DWC_REPORTFLAG_OPTION_CF                 0x10000000
    DWC_REPORTFLAG_OPTION_CONNTEST           0x20000000
    DWC_REPORTFLAG_GAMESPY                   0x80000000
    DWC_REPORTFLAG_TEST                      0x00100000
    DWC_REPORTFLAG_ALL                       0xffffffff
};

Constants

DWC_COMMONSTR_MAX_KEY_VALUE_LEN Maximum string length shared by the general-purpose strings key and value.

Error Enumerators

DWC_ERROR_NONE No error.
DWC_ERROR_DS_MEMORY_ANY Error related to system save data.
DWC_ERROR_AUTH_ANY Authentication-related error.
DWC_ERROR_AUTH_OUT_OF_SERVICE Service terminated.
DWC_ERROR_AUTH_STOP_SERVICE Service stopped temporarily.
DWC_ERROR_AC_ANY Error related to automatic connection.
DWC_ERROR_NETWORK Other network error.
DWC_ERROR_GHTTP_ANY GHTTP(HTTP)-related error.
DWC_ERROR_DISCONNECTED Disconnected.
DWC_ERROR_FATAL Fatal error.
DWC_ERROR_FRIENDS_SHORTAGE Attempted to begin friend-specified peer matchmaking without the specified number of valid friends.
DWC_ERROR_NOT_FRIEND_SERVER With server-client matchmaking, either the server-specified friends are not mutual friends, or the server is down.
DWC_ERROR_SERVER_FULL The server-client matchmaking server has exceeded the maximum number of participants.
DWC_ERROR_ND_ANY Download library error.
DWC_ERROR_ND_HTTP Download library HTTP error.
DWC_ERROR_SVL_ANY Service locator error.
DWC_ERROR_SVL_HTTP Service locator HTTP error.
DWC_ERROR_PROF_PARSEERR Illegal character string check error.
DWC_ERROR_PROF_HTTP Illegal character string check HTTP error.
DWC_ERROR_DB_ANY DB library error.
DWC_ERROR_SC_CONNECT_BLOCK Client connection was denied by the server during server-client matchmaking.
DWC_ERROR_NETWORK_LIGHT NETWORK-related error handled as a light error.
DWC_ERROR_NUM

Error Types Indicating the Procedure Required on Error Detection

DWC_ETYPE_NO_ERROR No error.
DWC_ETYPE_LIGHT Only a game-specific display; error code display is not necessary.Recovery is possible by calling the DWC_ClearError function.
DWC_ETYPE_SHOW_ERROR Display the error code.Recovery is possible by calling the DWC_ClearError function.
DWC_ETYPE_SHUTDOWN_FM The FriendsMatch library must be shut down by calling the DWC_ShutdownFriendsMatch function. Display the error code.
DWC_ETYPE_SHUTDOWN_GHTTP Call the following library release functions, as needed.The DWC_RnkShutdown function (General-Purpose Ranking Library). Display the error code.
DWC_ETYPE_SHUTDOWN_ND You must call the DWC_NdCleanupAsync function and close the download library. Display the error code.
DWC_ETYPE_DISCONNECT Call the following library release functions as needed: DWC_ShutdownFriendsMatch function (FriendsMatch library)DWC_NdCleanupAsync function (Download library)DWC_RnkShutdown function (General-Purpose Ranking library). *See Note below. After this, communications must be terminated by calling SOCleanup() and SOFinish(). Display the error code.
Note 2: Because the General-Purpose Ranking library uses the HTTP Communications library, DWC_InitGHTTP and DWC_ShutdownGHTTP are called from inside the initialize and exit operations of the General-Purpose Ranking library.
Note 3: In the current version, the application cannot use DWC_GHTTP directly.
DWC_ETYPE_FATAL Since this corresponds to FatalError, you must prompt the user to turn the power OFF or to return to the Wii menu. Display the error code.
DWC_ETYPE_NUM

dwc_base Error Code Elements for Debugging

DWC_ECODE_SEQ_LOGIN Error during login processing.
DWC_ECODE_SEQ_FRIEND Error during friend management processing.
DWC_ECODE_SEQ_MATCH Error during the matchmaking process.
DWC_ECODE_SEQ_ETC Error during processing that is not listed.
DWC_ECODE_GS_GP GameSpyGP error.
DWC_ECODE_GS_PERS GameSpyPersistent error.
DWC_ECODE_GS_STATS GameSpyStats error.
DWC_ECODE_GS_QR2 GameSpyQR2 error.
DWC_ECODE_GS_SB GameSpyServerBrowsing error.
DWC_ECODE_GS_NN GameSpyNatNegotiation error.
DWC_ECODE_GS_GT2 GameSpygt2 error.
DWC_ECODE_GS_HTTP GameSpyHTTP error.
DWC_ECODE_GS_ETC Other GameSpy SDK error.
DWC_ECODE_TYPE_NETWORK Network failure.
DWC_ECODE_TYPE_SERVER GameSpy server failure.
DWC_ECODE_TYPE_DNS DNS failure.
DWC_ECODE_TYPE_DATA Received invalid data.
DWC_ECODE_TYPE_SOCKET Socket communication error.
DWC_ECODE_TYPE_BIND Socket bind error.
DWC_ECODE_TYPE_TIMEOUT Timeout has occurred.
DWC_ECODE_TYPE_PEER Problem with one-on-one communication.
DWC_ECODE_TYPE_CONN_OVER Exceeded number of connections.
DWC_ECODE_TYPE_STATS_AUTH STATS server login error.
DWC_ECODE_TYPE_STATS_LOAD STATS server data load error.
DWC_ECODE_TYPE_STATS_SAVE STATS server data save error.
DWC_ECODE_TYPE_NOT_FRIEND The specified partner is not a registered friend.
DWC_ECODE_TYPE_OTHER The partner disconnected communications (usually occurs under server-client matchmaking).
DWC_ECODE_TYPE_MUCH_FAILURE Failed NAT negotiations for the specified number of times.
DWC_ECODE_TYPE_SC_CL_FAIL The server-client matchmaking client failed to connect.
DWC_ECODE_TYPE_CLOSE Error while closing connections.
DWC_ECODE_TYPE_TRANS_HEADER Reliable data was received in an impossible reception state.
DWC_ECODE_TYPE_TRANS_BODY Receive buffer overflow.
DWC_ECODE_TYPE_TRANS_SEND Reliable transfer failure
DWC_ECODE_TYPE_TRANS_UNKNOWN_PEER Receipt from a gt2 connection that is unrecognized by the local host.
DWC_ECODE_TYPE_AC_FATAL Error group for AC during AC processing. In this case, the lower-order digits represent a dedicated state value.
DWC_ECODE_TYPE_OPEN_FILE Failed to open GHTTP file.
DWC_ECODE_TYPE_INVALID_POST Invalid GHTTP transmission.
DWC_ECODE_TYPE_REQ_INVALID GHTTP file name or similar data is invalid.
DWC_ECODE_TYPE_UNSPECIFIED Unspecified GHTTP error.
DWC_ECODE_TYPE_BUFF_OVER GHTTP buffer overflow.
DWC_ECODE_TYPE_PARSE_URL GHTTPURL analysis error.
DWC_ECODE_TYPE_BAD_RESPONSE Error analyzing the response from the GHTTP server.
DWC_ECODE_TYPE_REJECTED Rejection of requests or other messages from a GHTTP server.
DWC_ECODE_TYPE_FILE_RW GHTTP local file read/write error.
DWC_ECODE_TYPE_INCOMPLETE GHTTP download aborted.
DWC_ECODE_TYPE_TO_BIG Download not permitted because the GHTTP file is too large.
DWC_ECODE_TYPE_ENCRYPTION GHTTP encryption error.
DWC_ECODE_TYPE_ALLOC Failed to allocate memory.
DWC_ECODE_TYPE_PARAM Parameter error.
DWC_ECODE_TYPE_SO_SOCKET A GameSpy gt2 socket error was caused by an SO error.
DWC_ECODE_TYPE_NOT_INIT The socket library is not initialized.
DWC_ECODE_TYPE_DUP_INIT The library has been initialized twice.
DWC_ECODE_TYPE_WM_INIT Failure to initialize WM.
DWC_ECODE_TYPE_UNEXPECTED An unexpected state or an unknown GameSpy error has occurred.
DWC_ECODE_SEQ_ADDINS Extended feature error.
DWC_ECODE_FUNC_PROF The region for the name-check feature
DWC_ECODE_FUNC_ND Region used for DWC_Nd.
DWC_ECODE_TYPE_ND_ALLOC Failed to allocate memory.
DWC_ECODE_TYPE_ND_FATAL Used for other fatal errors.
DWC_ECODE_TYPE_ND_STATE A function was called in a state in which it cannot be called.
DWC_ECODE_TYPE_ND_HTTP HTTP communication failure.
DWC_ECODE_TYPE_ND_PARAM Invalid parameter was passed to the function.
DWC_ECODE_TYPE_ND_CANCEL Asynchronous processing has been canceled.
DWC_ECODE_TYPE_ND_SERVER_PARAM Invalid parameter has been sent to the server.
DWC_ECODE_TYPE_ND_SERVER_SERVICE Unregistered service.
DWC_ECODE_TYPE_ND_SERVER_INVALIDTOKEN Illegal token (service locator information).
DWC_ECODE_TYPE_ND_SERVER_TOKENEXPIRED Expired token (service locator information).
DWC_ECODE_TYPE_ND_SERVER_NOCONTENTS No content present.
DWC_ECODE_TYPE_ND_SERVER_ATTR Attribute does not match.
DWC_ECODE_TYPE_ND_SERVER_CONTENTSEXPIRED Expired content.
DWC_ECODE_TYPE_ND_SERVER_INVALIDAP Access from an access point that is not a service target.
DWC_ECODE_TYPE_ND_SERVER_DATABASE Cannot connect to database (problem with the download server).
DWC_ECODE_TYPE_ND_SERVER_PASSWORD Password does not match.
DWC_ECODE_TYPE_PROF_CONNERR Abnormal communications with the server used for illegal character string check.
DWC_ECODE_TYPE_PROF_PARSEERR Unable to correctly parse a character string from the server used for illegal character string check.
DWC_ECODE_TYPE_PROF_OTHERERR Some other error occurred in communications with the server used for illegal character string check.

Enumerators Indicating the Authentication Server Type

DWC_AUTHSERVER_DEBUG Server for development.
DWC_AUTHSERVER_RELEASE Server for products.
DWC_AUTHSERVER_TEST Do not use.

Flag for Outputting DWC Debug Information

DWC_REPORTFLAG_NONE
DWC_REPORTFLAG_INFO
DWC_REPORTFLAG_ERROR
DWC_REPORTFLAG_DEBUG
DWC_REPORTFLAG_WARNING
DWC_REPORTFLAG_ACHECK
DWC_REPORTFLAG_LOGIN
DWC_REPORTFLAG_MATCH_NN
DWC_REPORTFLAG_MATCH_GT2
DWC_REPORTFLAG_TRANSPORT
DWC_REPORTFLAG_QR2_REQ
DWC_REPORTFLAG_SB_UPDATE
DWC_REPORTFLAG_SEND_INFO
DWC_REPORTFLAG_RECV_INFO
DWC_REPORTFLAG_UPDATE_SV
DWC_REPORTFLAG_CONNECTINET
DWC_REPORTFLAG_AUTH
DWC_REPORTFLAG_AC
DWC_REPORTFLAG_BM
DWC_REPORTFLAG_UTIL
DWC_REPORTFLAG_OPTION_CF
DWC_REPORTFLAG_OPTION_CONNTEST
DWC_REPORTFLAG_GAMESPY
DWC_REPORTFLAG_TEST
DWC_REPORTFLAG_ALL

CONFIDENTIAL