WebCFace 2.5.2
Web-based Communication Framework & Dashboard-like UI
Loading...
Searching...
No Matches
client.h
Go to the documentation of this file.
1#include "def_types.h"
2
3#ifdef __cplusplus
4extern "C" {
5#endif
6
20
31 const char *host, int port);
37WEBCFACE_DLL wcfClient *WEBCFACE_CALL wcfInitW(const wchar_t *name,
38 const wchar_t *host, int port);
52
105 int enabled);
106
141 int timeout);
155// /*!
156// * \brief 別スレッドでwcfSync()を自動的に呼び出すようにする。
157// * \since ver2.0
158// *
159// * * wcfStart() や wcfWaitConnection() より前に設定する必要がある。
160// * *
161// autoSyncが有効の場合、別スレッドで一定間隔(100μs)ごとにwcfSync()が呼び出され、
162// * 各種コールバック (onEntry, onChange, Funcなど)
163// * も別のスレッドで呼ばれることになる
164// * (そのためmutexなどを適切に設定すること)
165// * * デフォルトでは無効なので、手動でwcfSync()などを呼び出す必要がある
166// *
167// * \param wcli
168// * \param enabled 0以外にすると有効、0にすると無効になる。デフォルトは無効
169// * \sa wcfSync(), wcfLoopSyncFor(), wcfLoopSync()
170// */
171// WEBCFACE_DLL wcfStatus WEBCFACE_CALL wcfAutoSync(wcfClient *wcli, int
172// enabled);
173
190
209 const char **list, int size,
210 int *members_num);
217 const wchar_t **list,
218 int size, int *members_num);
232 wcfClient *wcli, wcfEventCallback1 callback, void *user_data);
239 wcfClient *wcli, wcfEventCallback1W callback, void *user_data);
240
264
265#ifdef __cplusplus
266}
267#endif
const char * wcfServerHostName(wcfClient *wcli)
WebCFaceサーバーのホスト名を返す
Definition client.cc:232
wcfClient * wcfInitDefaultW(const wchar_t *name)
クライアントを初期化する (アドレスとポートはデフォルト, wstring)
Definition client.cc:20
wcfStatus wcfClose(wcfClient *wcli)
クライアントを閉じる
Definition client.cc:38
int wcfIsConnected(wcfClient *wcli)
Clientが接続されているかどうかを返す
Definition client.cc:30
wcfClient * wcfInitDefault(const char *name)
クライアントを初期化する (アドレスとポートはデフォルト)
Definition client.cc:17
wcfStatus wcfMemberEntryEventW(wcfClient *wcli, wcfEventCallback1W callback, void *user_data)
Memberが追加された時のイベント (wstring)
Definition client.cc:213
const char * wcfServerName(wcfClient *wcli)
WebCFaceサーバーの識別情報を返す
Definition client.cc:225
wcfClient * wcfInitW(const wchar_t *name, const wchar_t *host, int port)
クライアントを初期化する (wstring)
Definition client.cc:12
wcfClient * wcfInit(const char *name, const char *host, int port)
クライアントを初期化する
Definition client.cc:7
void wcfUsingUTF8(int flag)
webcfaceが使用するエンコーディングを設定する
Definition client.cc:5
wcfStatus wcfDestroy(void *ptr)
wcfの関数から取得したポインタのデータを破棄
Definition client.cc:105
wcfStatus wcfMemberEntryEvent(wcfClient *wcli, wcfEventCallback1 callback, void *user_data)
Memberが追加された時のイベント
Definition client.cc:209
int wcfIsValid(wcfClient *wcli)
有効なClientのポインタであるかを返す
Definition client.cc:23
wcfStatus wcfLoopSync(wcfClient *wcli)
送信用にセットしたデータをすべて送信キューに入れ、受信したデータを処理する
Definition client.cc:88
wcfStatus wcfLoopSyncFor(wcfClient *wcli, int timeout)
送信用にセットしたデータをすべて送信キューに入れ、受信したデータを処理する
Definition client.cc:80
wcfStatus wcfAutoReconnect(wcfClient *wcli, int enabled)
通信が切断されたときに自動で再試行するかどうかを設定する。
Definition client.cc:64
const char * wcfServerVersion(wcfClient *wcli)
WebCFaceサーバーのバージョン情報を返す
Definition client.cc:218
wcfStatus wcfSync(wcfClient *wcli)
送信用にセットしたデータをすべて送信キューに入れ、受信したデータを処理する
Definition client.cc:72
wcfStatus wcfStart(wcfClient *wcli)
サーバーへの接続を別スレッドで開始する。
Definition client.cc:48
wcfStatus wcfWaitConnection(wcfClient *wcli)
サーバーへの接続を別スレッドで開始し、成功するまで待機する。
Definition client.cc:56
wcfStatus wcfMemberListW(wcfClient *wcli, const wchar_t **list, int size, int *members_num)
サーバーに接続されている他のmemberのリストを得る。
Definition client.cc:205
wcfStatus wcfMemberList(wcfClient *wcli, const char **list, int size, int *members_num)
サーバーに接続されている他のmemberのリストを得る。
Definition client.cc:201
void wcfClient
Definition def_types.h:14
wcfStatus
Definition def_types.h:18
void(* wcfEventCallback1W)(const wchar_t *member, void *user_data)
イベントに登録する、引数1つ(+voidポインタ)を取るコールバックの型 (wstring)
Definition def_types.h:171
void(* wcfEventCallback1)(const char *member, void *user_data)
イベントに登録する、引数1つ(+voidポインタ)を取るコールバックの型
Definition def_types.h:164
#define WEBCFACE_DLL
Definition webcface-config.h:60
#define WEBCFACE_CALL
Definition webcface-config.h:97