AquaMessageSystem::CAquaMessageSystem Class Reference

メッセージシステムクラス More...

#include <AquaMessageSystem.h>

Inheritance diagram for AquaMessageSystem::CAquaMessageSystem:

Inheritance graph
[legend]
Collaboration diagram for AquaMessageSystem::CAquaMessageSystem:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 CAquaMessageSystem ()
 コンストラクタ
virtual CAquaMessageSystem ()
 デストラクタ
int CreateSessions (int session_max)
 通信用セッションの作成
int CreateListenSessions (int listen_session_max)
 通信待ち受け用セッションの作成
int CreateUDPSessions (int udp_session_max)
 UDP通信用セッションの作成.
void ReleaseSessions (void)
 通信用セッションの削除
void ReleaseListenSessions (void)
 通信待ち受け用セッションの削除
void ReleaseUDPSessions (void)
 UDP通信用セッションの削除.
int InitSocketEvent (void)
 SocketEventの初期化.
int DispatchSocketEvent (void)
 SocketEventの発信.
int InitCrypt (void)
 暗号化処理の初期化
int listen (const char *service, int family, eAquaMessageSystemCryptoAlgorithm CryptoAlgorithm=AQUAMESSYS_CRYPTO_ALGORITHM_NONE)
 セッションからの待ち受けを開始する
void close_listen (const char *service)
 セッションからの待ち受けを終了する
int load_auth_user_list (LPCTSTR lpFileName)
 認証用ユーザリストをロードする
CAquaMessageSessionconnect (const char *hostname, const char *service)
 セッションへの接続する
CAquaMessageSessionconnect (const char *hostname, const char *service, LPCTSTR uid, size_t uid_size, LPCTSTR passwd, size_t passwd_size)
 セッションへの接続を行い、ユーザ認証要求を送信します
void close (class CAquaMessageSession *session)
 セッションへの切断を行う
CAquaMessageSessionopen_udp (int family)
 UDPセッションを開く.
void close_udp (class CAquaMessageSession *session)
 UDPセッションの切断を行う.
int open_udp_bind (const char *service, int family)
 UDPBindセッションを開く.
void close_udp_bind (const char *service)
 UDPBindセッションを閉じる.
int add_user (LPCTSTR uid, size_t uid_size, LPCTSTR passwd, size_t passwd_size)
 ユーザの追加をする
int delete_user (LPCTSTR uid, size_t uid_size)
 指定uid(ユーザID)のユーザを削除をする
int delete_alluser (void)
 全ユーザの追加をする
CAquaMessageUser reference_user (LPCTSTR uid, size_t uid_size) const
 ユーザ情報参照をする
CAquaMessageUserget_user (LPCTSTR uid, size_t uid_size)
 ユーザの情報を取得する
const CAquaMessageUserget_user (LPCTSTR uid, size_t uid_size) const
 ユーザの情報を取得する(const)
int add_ExtensionCallFunction (const tagExtensionCallFunction &ExtensionCallFunction)
 拡張メッセージデータを追加する
int delete_ExtensionCallFunction (int type)
 指定した拡張メッセージデータを削除する
int delete_allExtensionCallFunction (void)
 全拡張メッセージデータを削除する


Detailed Description

メッセージシステムクラス

Note:
メッセージに関する以下の機能を統括します
・ユーザセッションの管理
・ユーザの管理
ユーザはCAquaMessageSystemで管理されたセッションAquaNetworkSystemCAquaNetworkSessionは使用せず 間接的なセッションクラスであるCAquaMessageSessionクラスオブジェクトを使用する

Constructor & Destructor Documentation

AquaMessageSystem::CAquaMessageSystem::CAquaMessageSystem (  ) 

コンストラクタ

コンストラクタ


Member Function Documentation

int AquaMessageSystem::CAquaMessageSystem::InitSocketEvent ( void   )  [virtual]

SocketEventの初期化.

SocketEventの初期化

Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::DispatchSocketEvent ( void   )  [virtual]

SocketEventの発信.

SocketEventの発信

Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::listen ( const char *  service,
int  family,
eAquaMessageSystemCryptoAlgorithm  AquaMessageSystemCryptoAlgorithm = AQUAMESSYS_CRYPTO_ALGORITHM_NONE 
) [virtual]

セッションからの待ち受けを開始する

セッションからの待ち受けを開始する

Parameters:
service 待ち受けサービス名
family 使用するTCP/IPアドレスファミリー(PF_INET/PF_INET6/PF_UNSPEC)
AquaMessageSystemCryptoAlgorithm 通信暗号に使用するアルゴリズム
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

void AquaMessageSystem::CAquaMessageSystem::close_listen ( const char *  service  ) 

セッションからの待ち受けを終了する

セッションからの待ち受けを終了する

Parameters:
service 待ち受けを終了するサービス名

int AquaMessageSystem::CAquaMessageSystem::load_auth_user_list ( LPCTSTR  lpFileName  )  [virtual]

認証用ユーザリストをロードする

認証用ユーザリストをロードする

Parameters:
lpFileName 認証用ユーザリストのファイル名
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

CAquaMessageSession * AquaMessageSystem::CAquaMessageSystem::connect ( const char *  hostname,
const char *  service 
) [virtual]

セッションへの接続する

セッションへの接続する

Parameters:
hostname 接続先ホスト名
service 接続先サービス名
Return values:
セッションクラスのオブジェクトへのポインタ。失敗時はNULLが返ります。 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

CAquaMessageSession * AquaMessageSystem::CAquaMessageSystem::connect ( const char *  hostname,
const char *  service,
LPCTSTR  uid,
size_t  uid_size,
LPCTSTR  passwd,
size_t  passwd_size 
) [virtual]

セッションへの接続を行い、ユーザ認証要求を送信します

セッションへの接続を行い、ユーザ認証要求を送信します

Parameters:
hostname 接続先ホスト名
service 接続先サービス名
uid 認証するユーザ情報のuid(ユーザID)へのポインタ
uid_size 認証するユーザ情報のuid(ユーザID)の長さ
passwd 認証するユーザ情報のpasswd(パスワード)へのポインタ
passwd_size 認証するユーザ情報のpasswdpasswd(パスワード)の長さ
Return values:
セッションクラスのオブジェクトへのポインタ。失敗時はNULLが返ります。 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

void AquaMessageSystem::CAquaMessageSystem::close ( class CAquaMessageSession session  )  [virtual]

セッションへの切断を行う

セッションへの切断を行う

Parameters:
session 切断するセッションが関連付けられたメッセージ通信セッションオブジェクト(CAquaMessageSession)

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

CAquaMessageSession * AquaMessageSystem::CAquaMessageSystem::open_udp ( int  family  )  [virtual]

UDPセッションを開く.

UDPセッションを開く

Parameters:
family 使用するTCP/IPアドレスファミリー(PF_INET/PF_INET6)
Return values:
セッションクラスのオブジェクトへのポインタ。失敗時はNULLが返ります。 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

void AquaMessageSystem::CAquaMessageSystem::close_udp ( class CAquaMessageSession session  )  [virtual]

UDPセッションの切断を行う.

UDPセッションの切断を行う

Parameters:
session 切断するUDPセッションが関連付けられたメッセージ通信セッションオブジェクト(CAquaMessageSession)

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::open_udp_bind ( const char *  service,
int  family 
) [virtual]

UDPBindセッションを開く.

UDPBindセッションを開く

Parameters:
service 待ち受けサービス名
family 使用するTCP/IPアドレスファミリー(PF_INET/PF_INET6/PF_UNSPEC)
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

void AquaMessageSystem::CAquaMessageSystem::close_udp_bind ( const char *  service  )  [virtual]

UDPBindセッションを閉じる.

UDPBindセッションを閉じる

Parameters:
service 待ち受けを終了するサービス名

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::add_user ( LPCTSTR  uid,
size_t  uid_size,
LPCTSTR  passwd,
size_t  passwd_size 
) [virtual]

ユーザの追加をする

ユーザの追加をする

Parameters:
uid 追加するuid(ユーザID)へのポインタ
uid_size 追加するuid(ユーザID)の長さ
passwd 追加するpasswd(パスワード)へのポインタ
passwd_size 追加するpasswd(パスワード)の長さ
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::delete_user ( LPCTSTR  uid,
size_t  uid_size 
) [virtual]

指定uid(ユーザID)のユーザを削除をする

指定uid(ユーザID)のユーザを削除をする

Parameters:
uid 削除するuid(ユーザID)へのポインタ
uid_size 削除するuid(ユーザID)の長さ
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::delete_alluser ( void   )  [virtual]

全ユーザの追加をする

全ユーザの追加をする

Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

CAquaMessageUser AquaMessageSystem::CAquaMessageSystem::reference_user ( LPCTSTR  uid,
size_t  uid_size 
) const [virtual]

ユーザ情報参照をする

ユーザ情報参照をする

Parameters:
uid 参照するユーザ情報のuid(ユーザID)へのポインタ
uid_size 参照するユーザ情報のuid(ユーザID)の長さ
Return values:
ユーザ情報への参照 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

CAquaMessageUser * AquaMessageSystem::CAquaMessageSystem::get_user ( LPCTSTR  uid,
size_t  uid_size 
) [virtual]

ユーザの情報を取得する

ユーザの情報を取得する

Parameters:
uid 取得するユーザ情報のuid(ユーザID)へのポインタ
uid_size 取得するユーザ情報のuid(ユーザID)の長さ
Return values:
ユーザー情報へのポインタ 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

const CAquaMessageUser * AquaMessageSystem::CAquaMessageSystem::get_user ( LPCTSTR  uid,
size_t  uid_size 
) const [virtual]

ユーザの情報を取得する(const)

ユーザの情報を取得する(const)

Parameters:
uid 取得するユーザ情報のuid(ユーザID)へのポインタ
uid_size 取得するユーザ情報のuid(ユーザID)の長さ
Return values:
ユーザー情報へのポインタ 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::add_ExtensionCallFunction ( const tagExtensionCallFunction ExtensionCallFunction  )  [virtual]

拡張メッセージデータを追加する

拡張メッセージデータを追加する

Parameters:
ExtensionCallFunction 追加する拡張メッセージデータへの参照
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::delete_ExtensionCallFunction ( int  type  )  [virtual]

指定した拡張メッセージデータを削除する

指定した拡張メッセージデータを削除する

Parameters:
type 削除する追加する拡張メッセージデータの種別
Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.

int AquaMessageSystem::CAquaMessageSystem::delete_allExtensionCallFunction ( void   )  [virtual]

全拡張メッセージデータを削除する

全拡張メッセージデータを削除する

Return values:
1:正常終了 
0:異常終了 

Implements AquaMessageSystem::CAquaMessageSystemAbstract.


The documentation for this class was generated from the following files:
Generated on Tue Jan 20 17:38:03 2009 for AquaMessageSystem by  doxygen 1.5.4