WebCFace 2.5.2
Web-based Communication Framework & Dashboard-like UI
Loading...
Searching...
No Matches
member.h File Reference
#include "def_types.h"
Include dependency graph for member.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

wcfStatus wcfValueEntryList (wcfClient *wcli, const char *member, const char **list, int size, int *field_num)
 memberが公開しているValueのリストを得る
 
wcfStatus wcfValueEntryListW (wcfClient *wcli, const wchar_t *member, const wchar_t **list, int size, int *field_num)
 memberが公開しているValueのリストを得る
 
wcfStatus wcfTextEntryList (wcfClient *wcli, const char *member, const char **list, int size, int *field_num)
 memberが公開しているTextのリストを得る
 
wcfStatus wcfTextEntryListW (wcfClient *wcli, const wchar_t *member, const wchar_t **list, int size, int *field_num)
 memberが公開しているTextのリストを得る
 
wcfStatus wcfFuncEntryList (wcfClient *wcli, const char *member, const char **list, int size, int *field_num)
 memberが公開しているFuncのリストを得る
 
wcfStatus wcfFuncEntryListW (wcfClient *wcli, const wchar_t *member, const wchar_t **list, int size, int *field_num)
 memberが公開しているFuncのリストを得る
 
wcfStatus wcfViewEntryList (wcfClient *wcli, const char *member, const char **list, int size, int *field_num)
 memberが公開しているViewのリストを得る
 
wcfStatus wcfViewEntryListW (wcfClient *wcli, const wchar_t *member, const wchar_t **list, int size, int *field_num)
 memberが公開しているViewのリストを得る
 
wcfStatus wcfValueEntryEvent (wcfClient *wcli, const char *member, wcfEventCallback2 callback, void *user_data)
 Valueが追加された時のイベント
 
wcfStatus wcfValueEntryEventW (wcfClient *wcli, const wchar_t *member, wcfEventCallback2W callback, void *user_data)
 Valueが追加された時のイベント (wstring)
 
wcfStatus wcfTextEntryEvent (wcfClient *wcli, const char *member, wcfEventCallback2 callback, void *user_data)
 Textが追加された時のイベント
 
wcfStatus wcfTextEntryEventW (wcfClient *wcli, const wchar_t *member, wcfEventCallback2W callback, void *user_data)
 Textが追加された時のイベント (wstring)
 
wcfStatus wcfFuncEntryEvent (wcfClient *wcli, const char *member, wcfEventCallback2 callback, void *user_data)
 Funcが追加された時のイベント
 
wcfStatus wcfFuncEntryEventW (wcfClient *wcli, const wchar_t *member, wcfEventCallback2W callback, void *user_data)
 Funcが追加された時のイベント (wstring)
 
wcfStatus wcfViewEntryEvent (wcfClient *wcli, const char *member, wcfEventCallback2 callback, void *user_data)
 Viewが追加された時のイベント
 
wcfStatus wcfViewEntryEventW (wcfClient *wcli, const wchar_t *member, wcfEventCallback2W callback, void *user_data)
 Viewが追加された時のイベント (wstring)
 
wcfStatus wcfMemberSyncEvent (wcfClient *wcli, const char *member, wcfEventCallback1 callback, void *user_data)
 Memberがsyncした時のイベント
 
wcfStatus wcfMemberSyncEventW (wcfClient *wcli, const wchar_t *member, wcfEventCallback1W callback, void *user_data)
 Memberがsyncした時のイベント (wstring)
 
unsigned long long wcfMemberSyncTime (wcfClient *wcli, const char *member)
 最後のsync()の時刻を返す
 
unsigned long long wcfMemberSyncTimeW (wcfClient *wcli, const wchar_t *member)
 最後のsync()の時刻を返す
 
const char * wcfMemberLibName (wcfClient *wcli, const char *member)
 Memberが使っているWebCFaceライブラリの識別情報を返す
 
const char * wcfMemberLibVersion (wcfClient *wcli, const char *member)
 Memberが使っているWebCFaceのバージョンを返す
 
const char * wcfMemberRemoteAddr (wcfClient *wcli, const char *member)
 MemberのIPアドレスを返す
 
wcfStatus wcfMemberPingStatus (wcfClient *wcli, const char *member, int *value)
 memberの通信速度を取得
 
wcfStatus wcfMemberPingStatusW (wcfClient *wcli, const wchar_t *member, int *value)
 memberの通信速度を取得
 
wcfStatus wcfMemberPingEvent (wcfClient *wcli, const char *member, wcfEventCallback1 callback, void *user_data)
 Memberの通信速度が更新された時のイベント
 
wcfStatus wcfMemberPingEventW (wcfClient *wcli, const wchar_t *member, wcfEventCallback1W callback, void *user_data)
 Memberの通信速度が更新された時のイベント (wstring)
 

Function Documentation

◆ wcfFuncEntryEvent()

wcfStatus wcfFuncEntryEvent ( wcfClient wcli,
const char *  member,
wcfEventCallback2  callback,
void *  user_data 
)

Funcが追加された時のイベント

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfFuncEntryEventW()

wcfStatus wcfFuncEntryEventW ( wcfClient wcli,
const wchar_t *  member,
wcfEventCallback2W  callback,
void *  user_data 
)

Funcが追加された時のイベント (wstring)

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfFuncEntryList()

wcfStatus wcfFuncEntryList ( wcfClient wcli,
const char *  member,
const char **  list,
int  size,
int *  field_num 
)

memberが公開しているFuncのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList

◆ wcfFuncEntryListW()

wcfStatus wcfFuncEntryListW ( wcfClient wcli,
const wchar_t *  member,
const wchar_t **  list,
int  size,
int *  field_num 
)

memberが公開しているFuncのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList

◆ wcfMemberLibName()

const char * wcfMemberLibName ( wcfClient wcli,
const char *  member 
)

Memberが使っているWebCFaceライブラリの識別情報を返す

Since
ver2.0
Todo:
wstringバージョンも用意したほうがいいかも

◆ wcfMemberLibVersion()

const char * wcfMemberLibVersion ( wcfClient wcli,
const char *  member 
)

Memberが使っているWebCFaceのバージョンを返す

Since
ver2.0

◆ wcfMemberPingEvent()

wcfStatus wcfMemberPingEvent ( wcfClient wcli,
const char *  member,
wcfEventCallback1  callback,
void *  user_data 
)

Memberの通信速度が更新された時のイベント

Since
ver2.0
Parameters
wcli
callback実行する関数: const char* 型(Memberの名前が渡される)と void* 型の引数を1つずつ取り、何もreturnしない。
user_data関数に引数として渡す追加のデータ callbackが呼び出されるときに第2引数にそのまま渡される。
Returns
wcliが無効ならWCF_BAD_WCLI

◆ wcfMemberPingEventW()

wcfStatus wcfMemberPingEventW ( wcfClient wcli,
const wchar_t *  member,
wcfEventCallback1W  callback,
void *  user_data 
)

Memberの通信速度が更新された時のイベント (wstring)

Since
ver2.0
See also
wcfMemberPingEvent

◆ wcfMemberPingStatus()

wcfStatus wcfMemberPingStatus ( wcfClient wcli,
const char *  member,
int *  value 
)

memberの通信速度を取得

Since
ver2.0
  • 初回の呼び出しで通信速度データをリクエストし、 wcfSync()後通信速度が得られるようになる
  • Client自身に対しても使用可能
Parameters
wcli
member
valuepingの往復時間(ms)が返る
Returns
wcliが無効ならWCF_BAD_WCLI, また値を受信していなければWCF_NO_DATA

◆ wcfMemberPingStatusW()

wcfStatus wcfMemberPingStatusW ( wcfClient wcli,
const wchar_t *  member,
int *  value 
)

memberの通信速度を取得

Since
ver2.0
See also
wcfMemberPingStatus

◆ wcfMemberRemoteAddr()

const char * wcfMemberRemoteAddr ( wcfClient wcli,
const char *  member 
)

MemberのIPアドレスを返す

Since
ver2.0

◆ wcfMemberSyncEvent()

wcfStatus wcfMemberSyncEvent ( wcfClient wcli,
const char *  member,
wcfEventCallback1  callback,
void *  user_data 
)

Memberがsyncした時のイベント

Since
ver2.0
Parameters
wcli
callback実行する関数: const char* 型(Memberの名前が渡される)と void* 型の引数を1つずつ取り、何もreturnしない。
user_data関数に引数として渡す追加のデータ callbackが呼び出されるときに第2引数にそのまま渡される。
Returns
wcliが無効ならWCF_BAD_WCLI

◆ wcfMemberSyncEventW()

wcfStatus wcfMemberSyncEventW ( wcfClient wcli,
const wchar_t *  member,
wcfEventCallback1W  callback,
void *  user_data 
)

Memberがsyncした時のイベント (wstring)

Since
ver2.0
See also
wcfMemberSyncEvent

◆ wcfMemberSyncTime()

unsigned long long wcfMemberSyncTime ( wcfClient wcli,
const char *  member 
)

最後のsync()の時刻を返す

Since
ver2.0
Returns
1970/1/1 0:00(utc) からの経過ミリ秒数で表し、閏秒はカウントしない

◆ wcfMemberSyncTimeW()

unsigned long long wcfMemberSyncTimeW ( wcfClient wcli,
const wchar_t *  member 
)

最後のsync()の時刻を返す

Since
ver2.0
See also
wcfMemberSyncTime

◆ wcfTextEntryEvent()

wcfStatus wcfTextEntryEvent ( wcfClient wcli,
const char *  member,
wcfEventCallback2  callback,
void *  user_data 
)

Textが追加された時のイベント

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfTextEntryEventW()

wcfStatus wcfTextEntryEventW ( wcfClient wcli,
const wchar_t *  member,
wcfEventCallback2W  callback,
void *  user_data 
)

Textが追加された時のイベント (wstring)

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfTextEntryList()

wcfStatus wcfTextEntryList ( wcfClient wcli,
const char *  member,
const char **  list,
int  size,
int *  field_num 
)

memberが公開しているTextのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList

◆ wcfTextEntryListW()

wcfStatus wcfTextEntryListW ( wcfClient wcli,
const wchar_t *  member,
const wchar_t **  list,
int  size,
int *  field_num 
)

memberが公開しているTextのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList

◆ wcfValueEntryEvent()

wcfStatus wcfValueEntryEvent ( wcfClient wcli,
const char *  member,
wcfEventCallback2  callback,
void *  user_data 
)

Valueが追加された時のイベント

Since
ver2.0
Parameters
wcli
membermember名 (NULLまたは空文字列で自分自身を指す)
callback実行する関数: const char* 型2つ(追加されたMemberとfieldの名前が渡される)と void* 型の引数1つを取り、何もreturnしない。
user_data関数に引数として渡す追加のデータ callbackが呼び出されるときに第3引数にそのまま渡される。
Returns
wcliが無効ならWCF_BAD_WCLI

◆ wcfValueEntryEventW()

wcfStatus wcfValueEntryEventW ( wcfClient wcli,
const wchar_t *  member,
wcfEventCallback2W  callback,
void *  user_data 
)

Valueが追加された時のイベント (wstring)

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfValueEntryList()

wcfStatus wcfValueEntryList ( wcfClient wcli,
const char *  member,
const char **  list,
int  size,
int *  field_num 
)

memberが公開しているValueのリストを得る

Since
ver2.0
  • sizeに指定したサイズよりfieldの数が多い場合、 size分のfield名を格納する。
  • sizeに指定したサイズよりfieldの数が少ない場合、 size分より後ろの余った部分はそのまま
Parameters
wcli
membermember名 (NULLまたは空文字列で自分自身を指す)
listfield名を格納するchar*の配列 (size=0ならNULLも可)
sizelistの要素数
field_num実際のfield数
Returns
wcliが無効ならWCF_BAD_WCLI

◆ wcfValueEntryListW()

wcfStatus wcfValueEntryListW ( wcfClient wcli,
const wchar_t *  member,
const wchar_t **  list,
int  size,
int *  field_num 
)

memberが公開しているValueのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList

◆ wcfViewEntryEvent()

wcfStatus wcfViewEntryEvent ( wcfClient wcli,
const char *  member,
wcfEventCallback2  callback,
void *  user_data 
)

Viewが追加された時のイベント

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfViewEntryEventW()

wcfStatus wcfViewEntryEventW ( wcfClient wcli,
const wchar_t *  member,
wcfEventCallback2W  callback,
void *  user_data 
)

Viewが追加された時のイベント (wstring)

Since
ver2.0
See also
wcfValueEntryEvent

◆ wcfViewEntryList()

wcfStatus wcfViewEntryList ( wcfClient wcli,
const char *  member,
const char **  list,
int  size,
int *  field_num 
)

memberが公開しているViewのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList

◆ wcfViewEntryListW()

wcfStatus wcfViewEntryListW ( wcfClient wcli,
const wchar_t *  member,
const wchar_t **  list,
int  size,
int *  field_num 
)

memberが公開しているViewのリストを得る

Since
ver2.0
See also
wcfValueEntryEventList