CTR-Pia
5.4.3
Game Communication Engine
メインページ
ネームスペース一覧
クラス構成
クラス索引
関連ページ
Result 検索
全て
クラス
ネームスペース
関数
変数
型定義
列挙型
列挙型の値
ページ
transport_Api.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/transport/transport_Definitions.h>
17
18
19
namespace
nn
20
{
21
namespace
pia
22
{
23
namespace
transport
24
{
25
26
27
/*!
28
@brief transport モジュールが初期化された状態であるかどうかを返します。
29
30
@details この関数はスレッドセーフです。
31
<br>
32
@return transport モジュールが初期化されていれば true 、されていなければ false が返されます。
33
@see Initialize, Finalize
34
*/
35
bool
IsInitialized
(
void
);
36
37
38
/*!
39
@brief transport モジュールを初期化します。
40
41
@return 無事に初期化が完了すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
42
@retval ResultAlreadyInitialized 既に初期化は終了しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
43
@see IsInitialized, Finalize
44
*/
45
Result
Initialize
(
void
);
46
47
48
/*!
49
@brief transport モジュールを終了します。
50
Initialize() を呼び出していない状態でこの関数を呼び出した場合は、
51
何もせずに返ります。
52
53
@see IsInitialized, Initialize
54
*/
55
void
Finalize
(
void
);
56
57
58
/*!
59
@brief セットアップの開始を宣言します。
60
61
@details transport モジュールのシングルトンなどを作成する前に呼ぶ必要があります。
62
アプリケーションが transport モジュールのシングルトンを一つも作成しない場合であっても、
63
この関数と @ref EndSetup は必ず呼び出す必要があります。
64
65
@return この関数を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
66
@retval ResultNotInitialized transport::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
67
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
68
@see EndSetup
69
*/
70
Result
BeginSetup
(
void
);
71
72
73
/*!
74
@brief セットアップの終了を宣言します。
75
76
@details transport モジュールのシングルトンなどを作成し終えた後に呼ぶ必要があります。
77
この関数呼び出しにより、 transport モジュールのシングルトンなどが消費する
78
メモリを確定し、ライブラリ内部でのメモリ管理を最適化します。
79
アプリケーションが transport モジュールのシングルトンを一つも作成しない場合であっても、
80
@ref BeginSetup とこの関数は必ず呼び出す必要があります。
81
82
@return この関数を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
83
@retval ResultNotInitialized transport::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
84
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
85
@see BeginSetup
86
*/
87
Result
EndSetup
(
void
);
88
89
90
/*!
91
@cond PRIVATE
92
@brief BeginSetup() ~ EndSetup()間の状態であるかどうかを返します。
93
94
@details この関数はスレッドセーフです。
95
*/
96
bool
IsInSetupMode(
void
);
97
//! @endcond
98
}
99
}
100
}
// end of namespace nn::pia::transport
Include
nn
pia
transport
transport_Api.h
© 2016 Nintendo Co., Ltd. All rights reserved. 記載されている会社名、製品名等は、各社の登録商標または商標です。