Main Page | Modules | Class List | File List | Class Members | File Members

Callbacks
[Login Service]

The login service function callbacks. More...

Typedefs

typedef GSvoid(* CBLoginRcv_PlayerInfo )(GSubyte ubType, GSchar *szUsername, GSchar *szSurName, GSchar *szFirstName, GSchar *szCountry, GSchar *szEmail, GSchar *szIRCID, GSchar *szIPAddress, GSint iReason)
 Receive information on a player.

typedef GSvoid(* CBLoginRcv_JoinWaitModuleResult )(GSubyte ubType, GSchar *szAddress, GSushort usPort, GSint iReason)
 Receive status of the join wait module request.

typedef GSvoid(* CBLoginRcv_LoginRouterResult )(GSubyte ubType, GSint iReason)
 Receive status of the login request.

typedef GSvoid(* CBLoginRcv_LoginWaitModuleResult )(GSubyte ubType, GSint iReason)
 Receive status of the login wait module request.

typedef GSvoid(* CBLoginRcv_SystemPage )(GSint iSubType, GSchar *szText)
 Received a system page.

typedef GSvoid(* CBLoginRcv_LoginDisconnection )()
 Disconnection from router.

typedef GSvoid(* CBLoginRcv_AccountCreationResult )(GSubyte ubType, GSint iReason)
 Receive the status of the account creation request.

typedef GSvoid(* CBLoginRcv_ModifyUserResult )(GSubyte ubType, GSint iReason)
 Receive the status of the user modifycation request.

typedef GSvoid(* CBLoginRcv_RequestMOTD )(GSubyte ubType, GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason)
 Receive the message of the day.

Detailed Description

Typedef Documentation

typedef GSvoid( * CBLoginRcv_AccountCreationResult)(GSubyte ubType, GSint iReason)
 

Description:
This callback will be called when the client receive a response from the router after sending a account creation request
Related Function:
LoginSend_Disconnect()
Errors:
ERRORSECURE_USERNAMEEXISTS: The account name already exists.
ERRORSECURE_USERNAMEMALFORMED: The account name does not match the format rules ^[a-zA-Z][a-zA-Z0-9_\.-]{2,14}$.
ERRORSECURE_USERNAMEFORBIDDEN: The account name contains forbidden substrings (e.g. smut)
ERRORSECURE_USERNAMERESERVED: The account name is reserved
ERRORSECURE_PASSWORDMALFORMED: The password does not match the format rules ^.{2,16}$.
ERRORSECURE_PASSWORDFORBIDDEN: The password contains the username
ERRORSECURE_DATABASEFAILED: There is a problem with the database.
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
iReason The reason of failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_JoinWaitModuleResult)(GSubyte ubType, GSchar *szAddress, GSushort usPort, GSint iReason)
 

Description:
This callback will be called when the client receive a response from the router after asking to join the wait module. The client should then call LoginSend_Connect() with this szAddress and usPort.
Related Function:
LoginSend_JoinWaitModule()
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
szAddress IP address of the wait module
usPort The port of the wait module
iReason The reason of failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_LoginDisconnection)()
 

Description:
This callback will be called when the client is disconnected from the router

typedef GSvoid( * CBLoginRcv_LoginRouterResult)(GSubyte ubType, GSint iReason)
 

Description:
This callback will be called when the client receive a response from the router after asking to log into the router. If you reveive a GSSCUCCESS you can then call LoginSend_JoinWaitModule().
Related Function:
LoginSend_LoginRouter()
Errors:
ERRORSECURE_DATABASEFAILED: There is a problem with the Database.
ERRORROUTER_NOTDISCONNECTED: The player is already logged in.
ERRORSECURE_INVALIDPASSWORD: The password is not correct.
ERRORSECURE_LOCKEDACCOUNT: The account has been locked.
ERRORSECURE_INVALIDACCOUNT: The username doesn't exist.
ERRORSECURE_BANNEDACCOUNT: The account has been banned.
ERRORSECURE_BLOCKEDACCOUNT: The account has been blocked.
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
iReason The reason of failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_LoginWaitModuleResult)(GSubyte ubType, GSint iReason)
 

Description:
This callback will be called when the client receive a response from the router after asking to login to the wait module. After receving this callback you will be fully connected to the Game Service. It's recommened that the client now call LoginSend_PlayerInfo() with the players username to get his szIRCID and the correct case of his username.
Related Function:
LoginSend_LoginWaitModule()
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
iReason The reason of failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_ModifyUserResult)(GSubyte ubType, GSint iReason)
 

Description:
This callback will be called when the client receive a response from the router after sending a user info modification request
Related Function:
LoginSend_ModifyAccount()
Errors:
ERRORSECURE_PASSWORDMALFORMED: The password does not match the format rules ^.{2,16}$.
ERRORSECURE_PASSWORDFORBIDDEN: The password contains the username
ERRORSECURE_DATABASEFAILED: There is a problem with the database.
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
iReason The reason of failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_PlayerInfo)(GSubyte ubType, GSchar *szUsername, GSchar *szSurName, GSchar *szFirstName, GSchar *szCountry, GSchar *szEmail,GSchar *szIRCID, GSchar *szIPAddress, GSint iReason)
 

Description:
This callback will be called when the client requests information on a player
Related Function:
LoginSend_PlayerInfo()
Errors:
ERRORROUTER_DBPROBLEM: There is a problem with the database.
ERRORROUTER_NOTREGISTERED: The username doesn't exist.
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
szUsername The username of the player in the correct case
szSurName The last name of a player
szFirstName The first name of the player
szCountry The country of the player
szEmail Email address of the player
szIRCID Player's IRC ID
szIPAddress Player's ip address
iReason The reason of failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_RequestMOTD)(GSubyte ubType, GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason)
 

Description:
This callback will be called when the client receives the MOTDs from the server. The messages will never be greater the MOTDLENGTH.
Related function:
LoginSend_RequestMOTD()
Errors:
ERRORROUTER_DBPROBLEM: There is a problem with the database.
Parameters:
ubType The status of the message received back (GSSUCCESS or GSFAIL)
szUbiMOTD The message of the day for the Ubi.com Game Service
szGameMOTD The message of the day for the game.
iReason The reason for the failure if ubType is GSFAIL

typedef GSvoid( * CBLoginRcv_SystemPage)(GSint iSubType, GSchar *szText)
 

Description:
This callback will be called when the client received a system page wich is usually called by a administrator or when another player adds the client to his friend list.
Parameters:
iSubType The type of message. The possibilities are:
  • ADDEDASFRIEND
    The player was added to the friend list of the other player who's name is in the szText parameter
  • ADDEDASIGNOREE
    The player was added to the ignore list of the other player who's name is in the szText parameter
  • REMOVEDASIGNOREE
    The player was removed from the ignore list of the other player who's name is in the szText parameter
szText The actual message

Ubi.com GameService SDK - ©UbiSoft Entertainment 2002
GameService development team