Android SDK API リファレンス

クラス | 公開メンバ関数 | 静的公開メンバ関数 | 静的公開変数類 | 全メンバ一覧
io.skyway.Peer.DataConnection クラス

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

io.skyway.Peer.BaseConnectionを継承しています。

クラス

enum  DataEventEnum
 DataConnection の on メソッドのコールバックタイプ [詳解]
 

公開メンバ関数

int bufferSize ()
 送信待ちデータ数を取得します。 [詳解]
 
void on (DataEventEnum event, OnCallback callback)
 DataConnection のイベントコールバックを設定します。 [詳解]
 
boolean send (Object data)
 接続中のリモートピアに送信します。 [詳解]
 
void close ()
 データ通信接続の切断と解放をおこないます。 [詳解]
 
void getStats (StatsCollectorCallback callback)
 コネクションの統計情報を取得します。 [詳解]
 
void finalize ()
 
boolean isOpen ()
 コネクションの読み書き状態を取得します [詳解]
 
String peer ()
 リモート ピア ID を取得します [詳解]
 
String type ()
 コネクション種別文字列を取得します [詳解]
 
String label ()
 コネクションラベル文字列を取得します [詳解]
 
String connectionId ()
 コネクション ID を取得します [詳解]
 
boolean reliable ()
 データチャネルの信頼性を取得します [詳解]
 
SerializationEnum serialization ()
 送信されるデータ形式種別を取得します [詳解]
 
String metadata ()
 コネクションに関連するメタデータ文字列を取得します [詳解]
 
void getPeerConnectionState (OnCallback listener)
 
final Object peerConnection ()
 
Peer provider ()
 Peer オブジェクトを取得します [詳解]
 
final String browser ()
 
final Peer.PeerTypeEnum serverType ()
 

静的公開メンバ関数

static String getSerialization (SerializationEnum type)
 シリアライズ列挙子をシリアライズ種別文字列に変換します [詳解]
 
static SerializationEnum getSerializationEnum (String type)
 シリアライズ種別文字列をシリアライズ列挙子に変換します [詳解]
 

静的公開変数類

static final String TYPE_DATA = "data"
 
static final String TYPE_MEDIA = "media"
 
static final String SERIALIZATION_BINARY = "binary"
 
static final String SERIALIZATION_BINARY_UTF8 = "binary-utf8"
 
static final String SERIALIZATION_JSON = "json"
 
static final String SERIALIZATION_NONE = "none"
 

詳解

DataConnection 相当のクラスです。

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

メソッド詳解

◆ browser()

final String io.skyway.Peer.BaseConnection.browser ( )
inherited

◆ bufferSize()

int io.skyway.Peer.DataConnection.bufferSize ( )

送信待ちデータ数を取得します。

戻り値
送信待ちデータ数です。

◆ close()

void io.skyway.Peer.DataConnection.close ( )

データ通信接続の切断と解放をおこないます。

DataConnection data;
data.close();
data = null;

◆ connectionId()

String io.skyway.Peer.DataConnection.connectionId ( )

コネクション ID を取得します

戻り値
コネクション ID

◆ getPeerConnectionState()

void io.skyway.Peer.DataConnection.getPeerConnectionState ( OnCallback  listener)
引数
listenerlistener
非推奨:

◆ getSerialization()

static String io.skyway.Peer.BaseConnection.getSerialization ( SerializationEnum  type)
staticinherited

シリアライズ列挙子をシリアライズ種別文字列に変換します

引数
typeシリアライズ列挙子
戻り値
シリアライズ種別文字列
参照
#getSerializationEnum(String)

◆ getSerializationEnum()

static SerializationEnum io.skyway.Peer.BaseConnection.getSerializationEnum ( String  type)
staticinherited

シリアライズ種別文字列をシリアライズ列挙子に変換します

引数
typeシリアライズ種別文字列
戻り値
シリアライズ列挙子
参照
#getSerialization(SerializationEnum)

◆ getStats()

void io.skyway.Peer.DataConnection.getStats ( StatsCollectorCallback  callback)

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

DataConnection connection;
connection.getStats(new StatsCollectorCallback() {
@Override
public void onStatsDelivered(JSONArray stats) {
// Do something
}
});
引数
callback統計情報取得後のコールバックを設定します。

◆ isOpen()

boolean io.skyway.Peer.DataConnection.isOpen ( )

コネクションの読み書き状態を取得します

isOpen() 読み書き状態
true 読み書き可能
false 読み書き不可能
戻り値
コネクションの読み書き状態

◆ label()

String io.skyway.Peer.DataConnection.label ( )

コネクションラベル文字列を取得します

戻り値
コネクションラベル文字列

◆ metadata()

String io.skyway.Peer.DataConnection.metadata ( )

コネクションに関連するメタデータ文字列を取得します

戻り値
コネクションに関連するメタデータ文字列

◆ on()

void io.skyway.Peer.DataConnection.on ( DataEventEnum  event,
OnCallback  callback 
)

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

DataConnection data;
data.on(DataConnection.DataEventEnum.OPEN, new OnCallback() {
@Override
public void onCallback(Object object) {
// オープンしたときの処理等を記述
}
});
data.on(DataConnection.DataEventEnum.DATA, new OnCallback() {
@Override
public void onCallback(Object object) {
// 処理を記述
}
});
data.on(DataConnection.DataEventEnum.CLOSE, new OnCallback() {
@Override
public void onCallback(Object object) {
// 処理を記述
}
});
data.on(DataConnection.DataEventEnum.ERROR, new OnCallback() {
@Override
public void onCallback(Object object) {
// 処理を記述
}
});
引数
event設定するイベント種別を指定します。
callbackイベント発生時に実行するコールバックを設定します。

◆ peer()

String io.skyway.Peer.DataConnection.peer ( )

リモート ピア ID を取得します

戻り値
リモート ピア ID

◆ peerConnection()

final Object io.skyway.Peer.BaseConnection.peerConnection ( )
inherited

◆ provider()

Peer io.skyway.Peer.BaseConnection.provider ( )
inherited

Peer オブジェクトを取得します

戻り値
Peer オブジェクト

◆ reliable()

boolean io.skyway.Peer.DataConnection.reliable ( )

データチャネルの信頼性を取得します

戻り値
データチャネルの信頼性

◆ send()

boolean io.skyway.Peer.DataConnection.send ( Object  data)

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

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

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

json の場合、Array, Map などを JSON 文字列にしてバイナリ送受信します。

none の場合、String はテキスト送受信、それ以外は ByteBuffer に変換できる物をバイナリ送受信します。

DataConnection* data;
String message = "Send data.";
boolean bResult = data.send(message);
if (bResult) {
// successful.
} else {
// failure.
}
引数
data送信するオブジェクトを設定します。
戻り値
処理結果

◆ serialization()

SerializationEnum io.skyway.Peer.DataConnection.serialization ( )

送信されるデータ形式種別を取得します

戻り値
送信されるデータ形式種別

◆ serverType()

final Peer.PeerTypeEnum io.skyway.Peer.BaseConnection.serverType ( )
inherited

◆ type()

String io.skyway.Peer.DataConnection.type ( )

コネクション種別文字列を取得します

戻り値
コネクション種別文字列