lllogin.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:4k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lllogin.h
  3.  *
  4.  * $LicenseInfo:firstyear=2009&license=viewergpl$
  5.  * 
  6.  * Copyright (c) 2009-2010, Linden Research, Inc.
  7.  * 
  8.  * Second Life Viewer Source Code
  9.  * The source code in this file ("Source Code") is provided by Linden Lab
  10.  * to you under the terms of the GNU General Public License, version 2.0
  11.  * ("GPL"), unless you have obtained a separate licensing agreement
  12.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  13.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  14.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  15.  * 
  16.  * There are special exceptions to the terms and conditions of the GPL as
  17.  * it is applied to this Source Code. View the full text of the exception
  18.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  19.  * online at
  20.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  21.  * 
  22.  * By copying, modifying or distributing this software, you acknowledge
  23.  * that you have read and understood your obligations described above,
  24.  * and agree to abide by those obligations.
  25.  * 
  26.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  27.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  28.  * COMPLETENESS OR PERFORMANCE.
  29.  * $/LicenseInfo$
  30.  */
  31. #ifndef LL_LLLOGIN_H
  32. #define LL_LLLOGIN_H
  33. #include <boost/scoped_ptr.hpp>
  34. class LLSD;
  35. class LLEventPump;
  36. /**
  37.  * @class LLLogin
  38.  * @brief Class to encapsulate the action and state of grid login.
  39.  */
  40. class LLLogin
  41. {
  42. public:
  43. LLLogin();
  44. ~LLLogin();
  45. /** 
  46.  * Make a connection to a grid.
  47.  * @param uri The 'well known and published' authentication URL.
  48.  * @param credentials LLSD data that contians the credentials.
  49.  * *NOTE:Mani The credential data can vary depending upon the authentication
  50.  * method used. The current interface matches the values passed to
  51.  * the XMLRPC login request.
  52.  {
  53. method : string, 
  54. first : string,
  55. last : string,
  56. passwd : string,
  57. start : string,
  58. skipoptional : bool,
  59. agree_to_tos : bool,
  60. read_critical : bool,
  61. last_exec_event : int,
  62. version : string,
  63. channel : string,
  64. mac : string,
  65. id0 : string,
  66. options :   [ strings ]
  67.  }
  68.  
  69.  */
  70. void connect(const std::string& uri, const LLSD& credentials);
  71.     /** 
  72.  * Disconnect from a the current connection.
  73.  */
  74. void disconnect();
  75.     /** 
  76.  * Retrieve the event pump from this login class.
  77.  */
  78. LLEventPump& getEventPump();
  79. /*
  80. Event API
  81. LLLogin will issue multiple events to it pump to indicate the 
  82. progression of states through login. The most important 
  83. states are "offline" and "online" which indicate auth failure 
  84. and auth success respectively.
  85. pump: login (tweaked)
  86. These are the events posted to the 'login' 
  87. event pump from the login module.
  88. {
  89. state : string, // See below for the list of states.
  90. progress :   real // for progress bar.
  91. data :   LLSD // Dependent upon state.
  92. }
  93. States for method 'login_to_simulator'
  94. offline - set initially state and upon failure. data is the server response.
  95. srvrequest - upon uri rewrite request. no data.
  96. authenticating - upon auth request. data, 'attempt' number and 'request' llsd.
  97. downloading - upon ack from auth server, before completion. no data
  98. online - upon auth success. data is server response.
  99. Dependencies:
  100. pump: LLAres 
  101. LLLogin makes a request for a SRV record from the uri provided by the connect method.
  102. The following event pump should exist to service that request.
  103. pump name: LLAres
  104. request = {
  105. op : "rewriteURI"
  106. uri : string
  107. reply : string
  108. pump: LLXMLRPCListener
  109. The request merely passes the credentials LLSD along, with one additional 
  110. member, 'reply', which is the string name of the event pump to reply on. 
  111. */
  112. private:
  113. class Impl;
  114. boost::scoped_ptr<Impl> mImpl;
  115. };
  116. #endif // LL_LLLOGIN_H