CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
common_IPacketInput.h
1 /*--------------------------------------------------------------------------------*
2  Copyright (C)Nintendo All rights reserved.
3 
4  These coded instructions, statements, and computer programs contain proprietary
5  information of Nintendo and/or its licensed developers and are protected by
6  national and international copyright laws. They may not be disclosed to third
7  parties or copied or duplicated in any form, in whole or in part, without the
8  prior written consent of Nintendo.
9 
10  The content herein is highly confidential and should be handled accordingly.
11  *--------------------------------------------------------------------------------*/
12 
13 
14 #pragma once
15 
16 #include <nn/pia/common/common_Definitions.h>
17 
18 namespace nn
19 {
20 namespace pia
21 {
22 namespace common
23 {
24 
25 class Packet;
26 
27 /*!
28 @cond PRIVATE
29  @brief Packet を読み取るインタフェースとなるクラスです。
30  */
31 class IPacketInput
32 {
33 public:
34  /*!
35  @brief デフォルトコンストラクタです。
36  */
37  IPacketInput(void)
38  {
39  }
40 
41 
42  /*!
43  @brief デストラクタです。
44  */
45  virtual ~IPacketInput(void)
46  {
47  }
48 
49 
50  /*!
51  @brief 読み取りインタフェースです。
52 
53  @param[out] pPacketData Packetインスタンスへのポインタ。
54  @return 読み取りに成功すれば、IsSuccess()がtrueを返すResultが返ります。
55  @retval ResultInvalidArgument 引数が誤っています(NULLポインタが渡されたなど)
56  @retval ResultInvalidState このAPIを呼び出すタイミングが誤っています(初期化処理が済んでいないなど)
57  @retval ResultNoData 受信データが存在しなかった(データ未到着)ことを表します。
58  @retval ResultNetworkConnectionIsLost ネットワーク接続が失われた状態を示します。
59  */
60  virtual Result Read(nn::pia::common::Packet* pPacketData) = 0;
61 };
62 //! @endcond
63 }
64 }
65 } // end of namespace nn::pia::common