iOS SDK API リファレンス

実体メソッド | プロパティ | 全メンバ一覧
SKWDataConnection クラス

DataConnection 相当のクラスです。 [詳解]

#import <SKWDataConnection.h>

SKWDataConnection の継承関係図
SKWConnection

実体メソッド

(BOOL) - send:
 接続中のリモートピアにデータを送信します。 [詳解]
 
(void) - close
 データ通信接続の切断と解放をおこないます。forceClose オプションを NO として実行します。将来のバージョンから YES に変更される可能性があります。 [詳解]
 
(void) - close:
 forceClose オプションを指定して、データ通信接続の切断と解放をおこないます。 [詳解]
 
(void) - on:callback:
 SKWDataConnection のイベントコールバック Block を設定します。 [詳解]
 
(void) - getStats:
 コネクションの統計情報を取得します [詳解]
 

プロパティ

NSString *__nullable connectionId
 コネクション ID
 
NSString *__nullable metadata
 コネクションに関連するメタデータ文字列
 
BOOL isOpen
 コネクションの読み書き状態
 
NSString *__nullable peer
 リモートピア ID
 
NSString *__nullable type
 コネクション種別
 
NSString *__nullable label
 コネクションラベル文字列
 
BOOL reliable
 送信されるデータ形式種別です。コネクション作成時に定義されます。(データ接続でのみ有効です)
 
SKWSerializationEnum serialization
 送信されるデータ形式種別です。 コネクション作成時に定義されます。(データ接続でのみ有効です)
 
SKWPeer *__nullable provider
 この接続を作成したピアオブジェクトです
 

詳解

DataConnection 相当のクラスです。

このオブジェクトを取得するには SKWPeer の connectWithId メソッドを使用するか、 SKW_PEER_EVENT_CONNECTION イベント発生時に渡されるオブジェクトを使用してください。

メソッド詳解

◆ close

- (void) close

データ通信接続の切断と解放をおこないます。forceClose オプションを NO として実行します。将来のバージョンから YES に変更される可能性があります。

[data close];
data = nil;

◆ close:

- (void) close: (BOOL)  forceClose

forceClose オプションを指定して、データ通信接続の切断と解放をおこないます。

[data close:YES];
data = nil;
引数
forceCloseこの値がYESの場合、相手の DataConnection も即座に close します。

◆ getStats:

- (void) getStats: (SKWConnectionGetStatsCallback __nullable)  callback

コネクションの統計情報を取得します

引数
callback統計情報取得後のBlock を設定します。
SKWMediaConnection *connection;
[connection getStats:^(NSArray * _Nullable stats) {
// Do something
}];

◆ on:callback:

- (void) on: (SKWDataConnectionEventEnum event
callback: (__nullable SKWDataConnectionEventCallback callback 

SKWDataConnection のイベントコールバック Block を設定します。

[data on:SKW_DATACONNECTION_EVENT_OPEN callback:^(NSObject* obj) {
// オープンしたときの処理等を記述
}];
[data on:SKW_DATACONNECTION_EVENT_DATA callback:^(NSObject* obj) {
if ([obj isKindOfClass:[NSData class]]) {
NSData* dat = (NSData *)obj;
} else if ([obj isKindOfClass:[NSDictionary class]]) {
NSDictionary* dic = (NSDictionary *)obj;
}
else if ([obj isKindOfClass:[NSArray class]]) {
NSArray* ary = (NSArray *)obj;
} else if ([obj isKindOfClass:[NSString class]]) {
NSString* string = (NSString *)obj;
}
}];
[data on:SKW_DATACONNECTION_EVENT_CLOSE callback:^(NSObject* obj) {
// コネクションが切断したときの処理を記述
}];
[data on:SKW_DATACONNECTION_EVENT_ERROR callback:^(NSObject* obj) {
SKWPeerError* err = (SKWPeerError *)obj;
NSLog(@"%@", err);
}];
引数
event設定するイベント種別を指定します。
callbackイベント発生時に実行する Block を設定します。

◆ send:

- (BOOL) send: (NSObject *__nonnull)  data

接続中のリモートピアにデータを送信します。

プロパティ serialization の値によって送信処理が変わります。

binary / binary-utf8 の場合、js-binarypack 相当のシリアライズを行ってバイナリ送受信処理をおこないます。 送信先がブラウザーの場合に有用です。

json の場合、送信時は NSDictionary* / NSArray* を JSON オブジェクトデータに してバイナリ送信します。 受信は、バイナリデータを NSDictionary*, NSArray* として受信します。

none の場合、NSString* はテキストとして、それ以外は NSData* で変換できたオブ ジェクトをバイナリ送受信します。

NSString* strMsg = @"Send data.";
BOOL bResult = [data send:strMsg];
if (bResult) {
// success
}
else {
// failure
}
引数
data送信するオブジェクトを設定します。 NSData*, NSString*, NSNumber*, NSDictionary*, NSArray* を設定できます。
戻り値
処理結果
SKWDataConnection
DataConnection 相当のクラスです。
Definition: SKWDataConnection.h:41
SKWPeerError
エラー情報クラス
Definition: SKWPeerError.h:76
-[SKWDataConnection close]
void close()
データ通信接続の切断と解放をおこないます。forceClose オプションを NO として実行します。将来のバージョンから YES に変更される可能性があります。
-[SKWDataConnection send:]
BOOL send:(NSObject *__nonnull data)
接続中のリモートピアにデータを送信します。
-[SKWDataConnection on:callback:]
void on:callback:(SKWDataConnectionEventEnum event,[callback] __nullable SKWDataConnectionEventCallback callback)
SKWDataConnection のイベントコールバック Block を設定します。
SKWMediaConnection
MediaConnection 相当のクラスです。
Definition: SKWMediaConnection.h:52
-[SKWDataConnection close:]
void close:(BOOL forceClose)
forceClose オプションを指定して、データ通信接続の切断と解放をおこないます。
-[SKWConnection getStats:]
void getStats:(SKWConnectionGetStatsCallback __nullable callback)
コネクションの統計情報を取得します