前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFBNetwork
INetwork インターフェースのラッパークラスです。
#include <SFBNetwork.h.hpp>
class SFBNetwork : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBNetwork)

継承図

SFBNetwork クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0
× × ×

参照

BREW API IAddrInfo

メンバ

パブリック関数
SFCError AddRetryCB( AEECallback * cbRetry )
この関数は、 SFBNetwork::Start() 操作が再試行可能になったら通知されるように、クライアントが使用します。 SFBNetwork::Start() と合わせて使用し、「ネットワーク起動」トランザクションを制御します。
SFCError ExtFunc( AEECLSID clsid , VoidPtr buffer , SInt32 length )
今後追加するインターフェイスのバイナリ互換性を確保する拡張関数です。
SFCError ExtFunc( AEECLSID clsid , SFXBufferConstRef buffer )
今後追加するインターフェイスのバイナリ互換性を確保する拡張関数です。
SFCError GetLastNetDownReason( AEENetDownReason * reason )
最後のネットワークダウンの理由を返します。
SFCError GetMyIPAddrs( IPAddr * aipaAddr , SInt32Ptr number )
ローカルホストまたはデバイスの IP アドレスをネットワーク バイトオーダーで返します。
SFCError GetOpt( SInt32 name , VoidPtr data , SInt32Ptr length )
特定のネットワークオプションを問い合わす機能を提供します。
SFCError GetOpt( SInt32 name , SFXBufferPtr data )
特定のネットワークオプションを問い合わす機能を提供します。
SFCError IsQoSAware( BoolPtr QoSAware )
この関数は CDMA ネットワークでのみサポートされます。携帯電話が現在、QoS をサポートするシステム (認識システム) 上にあるか、QoS をサポートしないシステム (非認識システム) 上にあるかを問い合わせます。
SFCError NetStatus( AEENetStatus * netstatus , AEENetStats * constatus )
現在のネットワークステータスを返します。
static
SFBNetworkSmp
NewInstance( SFCErrorPtr exception = null )
SFBNetwork インスタンスを生成します。
static
SFBNetworkSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
SFBNetwork インスタンスを生成します。
SFCError OnEvent( SInt32 event , PFNNETWORKEVENT eventfn , VoidPtr user , Bool reg )
コール側は、ネットワークステータスの変更とイベントの通知を受け取るように登録できます。
SFCError SelectNetworkEx( SInt32 network , SInt16 family )
特定のデータネットワークを選択します。
SFCError SetDormancyTimeout( UInt08 seconds )
ネットワーク接続の IS-707 (cdma2000 1x) パケットデータのドーマンシータイムアウトを、ucSecs で指定される値に設定します。
SFCError SetLinger( UInt16 seconds , UInt16Ptr ldsecs )
ネットワーク接続のリンガー時間を、wSecs で指定される値に設定し、以前の値を pwOldSecs 内に返します。
SFCError SetOpt( SInt32 name , VoidPtr data , SInt32 length )
特定のネットワークオプションを構成する機能を提供します。
SFCError SetOpt( SInt32 name , SFXBufferConstRef data )
特定のネットワークオプションを構成する機能を提供します。
SFCError Start( Void )
ネットワーク接続を明示的に起動するために使用します。
SFCError QueryInterface( AEECLSID clsid , VoidHandle handle ) (SFBQuery から継承)
このオブジェクトからの別の API を問い合わせます。
SFCError QueryInterface( AEECLSID clsid , SFBBaseSmpPtr handle ) (SFBQuery から継承)
このオブジェクトからの別の API を問い合わせます。
SFBBaseSmp QueryInterface( AEECLSID clsid ) (SFBQuery から継承)
このオブジェクトからの別の API を問い合わせます。
Void Self( AEECLSID clsidReq , SFBQuerySmpPtr clone , AEECLSID clsidImp ) (SFBQuery から継承)
オブジェクトを単一インターフェースで実装するときに使います。
SFBQuerySmp Self( AEECLSID clsidReq , AEECLSID clsidImp ) (SFBQuery から継承)
オブジェクトを単一インターフェースで実装するときに使います。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBNetwork::AddRetryCB
この関数は、 SFBNetwork::Start() 操作が再試行可能になったら通知されるように、クライアントが使用します。 SFBNetwork::Start() と合わせて使用し、「ネットワーク起動」トランザクションを制御します。
[ public ]
SFCError AddRetryCB(
    AEECallback * cbRetry   // クライアントのコールバック
);

戻り値

  • AEE_SUCCESS: クライアントのコールバックが正常に格納された。
  • AEE_EBADPARM: pcbRetry が NULL。

参照

BREW API INetwork_AddRetryCB | SFBNetwork::Start


SFBNetwork::ExtFunc
今後追加するインターフェイスのバイナリ互換性を確保する拡張関数です。
[ public ]
SFCError ExtFunc(
    AEECLSID clsid   // クラスID
    VoidPtr buffer   // バッファ
    SInt32 length    // bufferのサイズ
);
[ public ]
SFCError ExtFunc(
    AEECLSID clsid             // クラスID
    SFXBufferConstRef buffer   // バッファ
);

参照

BREW API INETWORK_EXT_FUNC_GET_SELECTED_NETWORK | BREW API INETWORK_EXT_FUNC_IGNORE_TIMEOUT_VALS


SFBNetwork::GetLastNetDownReason
最後のネットワークダウンの理由を返します。
[ public ]
SFCError GetLastNetDownReason(
    AEENetDownReason * reason   // 最後のネットワークダウンの理由へのポインタ。
);

引数

reason

AEE_NET_SUCCESS 時に、(コール側が事前割り当てした) 理由値が入る。

戻り値

  • AEE_NET_SUCCESS: 成功。pnNetDownReason に最後のネットワークダウンの理由が読み込まれる。
  • AEE_NET_EFAULT: 下層から、予測外のネットワークダウンの理由が戻った。

他の AEE 専用エラーコードが戻ることもある。

参照

BREW API INetwork_GetLastNetDownReason


SFBNetwork::GetMyIPAddrs
ローカルホストまたはデバイスの IP アドレスをネットワーク バイトオーダーで返します。
[ public ]
SFCError GetMyIPAddrs(
    IPAddr * aipaAddr   // コール側が割り当てた IPAddr配列で、ローカルホストまたはデバイスの IP アドレスがこの中に返される
    SInt32Ptr number    // aipaAddr のサイズ (IPAddrエントリの数)
);

戻り値

  • AEE_NET_SUCCESS: 現在の IP アドレスが aipaAddr 内に返される。
  • AEE_NET_ENETNONET: ネットワークが使用可能でない。
  • AEE_NET_ENETDOWN: ネットワークサブシステムが使用可能でない。

他のエラーコードが戻ることもある。

解説

ほとんどのデバイスは最大 1 つの IP アドレスを返します。

参照

BREW API INetwork_GetMyIPAddrs


SFBNetwork::GetOpt
特定のネットワークオプションを問い合わす機能を提供します。
[ public ]
SFCError GetOpt(
    SInt32 name        // 取得するオプション
    VoidPtr data       // オプション固有データが入る。
    SInt32Ptr length   // data のサイズ
);
[ public ]
SFCError GetOpt(
    SInt32 name         // 取得するオプション
    SFXBufferPtr data   // オプション固有データが入る。
);

戻り値

  • AEE_SUCCESS: オプションが正常に取得された。
  • AEE_EPRIVLEVEL: オプションへのアクセスがアプレット特権によって禁止されている場合。
  • AEE_EUNSUPPORTED: nOptName が不明な場合。
  • AEE_EBADPARM: pOptVal が NULL以外であり、pnOptSize の設定値が、オプションデータを格納するには小さ過ぎる場合。

取得するオプションに応じて他のエラーコードが戻ることもある。

参照

BREW API INetwork_GetOpt


SFBNetwork::IsQoSAware
この関数は CDMA ネットワークでのみサポートされます。携帯電話が現在、QoS をサポートするシステム (認識システム) 上にあるか、QoS をサポートしないシステム (非認識システム) 上にあるかを問い合わせます。
[ public ]
SFCError IsQoSAware(
    BoolPtr QoSAware   // QoS 認識 / 非認識システム: True / False
);

戻り値

  • AEE_NET_SUCCESS: 成功。携帯電話は CDMA ネットワーク上にある。 pbIsQoSAware は、携帯電話が QoS 認識システム上にあるか ( TRUE)、QoS 非認識システム上にあるか ( FALSE) を示す。
  • AEE_NET_EOPNOTSUPP: 携帯電話が UMTS ネットワーク上にある。 pbIsQoSAware は無効。
  • AEE_NET_ENETNONET: ネットワークサブシステムが使用できない。

他の AEE 専用エラーコードが戻ることもある。

参照

BREW API INetwork_IsQoSAware


SFBNetwork::NetStatus
現在のネットワークステータスを返します。
[ public ]
SFCError NetStatus(
    AEENetStatus * netstatus   // 現在のネットワークステータスを返す。
    AEENetStats * constatus    // ネットワーク接続の統計を返す。
);

戻り値

  • AEE_SUCCESS: ネットワークステータスが正常に取得された。
  • AEE_EFAILED: ネットワークステータスの取得に失敗した。

他のエラーコードが戻ることもある。

参照

BREW API INetwork_NetStatus


SFBNetwork::NewInstance
SFBNetwork インスタンスを生成します。
[ public, static ]
SFBNetworkSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);
[ public, static ]
SFBNetworkSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBNetwork::OnEvent
コール側は、ネットワークステータスの変更とイベントの通知を受け取るように登録できます。
[ public ]
SFCError OnEvent(
    SInt32 event              // (NETWORK_EVENT_*) に対して登録するイベント
    PFNNETWORKEVENT eventfn   // イベントタイプ ervent の発生時にコールされるユーザーコールバック
    VoidPtr user              // ユーザー固有のデータ。このデータはコールバック関数でアプリケーションに渡し戻す必要がある
    Bool reg                  // TRUE : 登録を設定する / FALSE : 既存の登録をキャンセルする
);

戻り値

  • SUCCESS: 登録された場合。
  • EBADPARM: nEvent が無効、または pfn が NULLの場合。
  • ENOMEMORY: 割り当てに失敗した場合。
  • EALREADY: 登録済みの場合。

他のエラーコードが戻ることもある。

参照

BREW API INetwork_OnEvent


SFBNetwork::SelectNetworkEx
特定のデータネットワークを選択します。
[ public ]
SFCError SelectNetworkEx(
    SInt32 network   // データネットワークタイプ (AEE_NETWORK_*)
    SInt16 family    // アドレスファミリ (AEE_AF_*)
);

戻り値

  • AEE_NET_SUCCESS: データネットワークが選択された。
  • AEE_NET_EINVAL: 指定されたネットワーク (またはネットワークファミリの組み合わせ) が有効でない。
  • AEE_NET_EOPNOTSUPP: ネットワークが既に選択されている。
  • AEE_EFAILED: その他のエラー。

他のエラーコードが戻ることもある。

参照

BREW API INetwork_SelectNetworkEx


SFBNetwork::SetDormancyTimeout
ネットワーク接続の IS-707 (cdma2000 1x) パケットデータのドーマンシータイムアウトを、ucSecs で指定される値に設定します。
[ public ]
SFCError SetDormancyTimeout(
    UInt08 seconds   // 新しいドーマンシータイムアウト (秒)
);

戻り値

  • AEE_NET_SUCCESS: ドーマンシータイムアウトが正常に設定された。
  • AEE_NET_EOPNOTSUPP: 操作がサポートされていない (cdma2000 1x ネットワークではない)。

他のエラーコードが戻ることもある。

解説

接続の作成時に、デフォルトのドーマンシータイムアウトが 30 秒に設定されます。

ドーマンシータイムアウトに等しい期間中にネットワークトラフィックがない場合、その携帯電話がドーマンシーを開始する必要があります。

参照

BREW API INetwork_SetDormancyTimeout


SFBNetwork::SetLinger
ネットワーク接続のリンガー時間を、wSecs で指定される値に設定し、以前の値を pwOldSecs 内に返します。
[ public ]
SFCError SetLinger(
    UInt16 seconds     // 新しいリンガー時間 (秒)
    UInt16Ptr ldsecs   // 以前のリンガー時間 (秒) を返す
);

戻り値

  • AEE_SUCCESS: リンガー時間が正常に設定された。
  • AEE_EFAILED: 操作に失敗した。

他のエラーコードが戻ることもある。

解説

接続の作成時に、デフォルトの待機時間が 30 秒に設定されます。

参照

BREW API INetwork_SetLinger


SFBNetwork::SetOpt
特定のネットワークオプションを構成する機能を提供します。
[ public ]
SFCError SetOpt(
    SInt32 name     // 設定するオプション
    VoidPtr data    // 設定するオプション固有データ
    SInt32 length   // data が指す、オプション固有データのサイズ
);
[ public ]
SFCError SetOpt(
    SInt32 name              // 設定するオプション
    SFXBufferConstRef data   // 設定するオプション固有データ
);

戻り値

  • AEE_SUCCESS: オプションが正常に設定された。
  • AEE_EPRIVLEVEL: オプションへのアクセスがアプレット特権によって禁止されている場合。
  • AEE_EUNSUPPORTED: nOptName が不明な場合。
  • AEE_EBADPARM: nOptSizeが、正しいオプションデータに対応しないサイズに設定されている場合。

設定するオプションに応じて他のエラーコードが戻ることもある。

参照

BREW API INetwork_SetOpt


SFBNetwork::Start
ネットワーク接続を明示的に起動するために使用します。
[ public ]
SFCError Start(Void);

戻り値

  • SUCCESS: ネットワーク接続が正常に起動した。
  • AEE_NET_WOULDBLOCK: 現在、操作完了不能。 SFBNetwork::AddRetryCB()を使用して、後に再試行すること。
  • ENOMEMORY: メモリー不足。
  • AEE_NET_ENETNONET: ネットワークが使用可能でない。

他のエラーコードが戻ることもある。

解説

ネットワーク接続を明示的に起動するために使用します。ソケットなどのネットワークリソースを使用するとネットワークの起動が暗黙的に行われるため、通常、アプリケーションはこの関数を使用しません。

ネットワーク接続を起動するトランザクションは非同期操作であるため、AEE_NET_WOULDBLOCK が返されることがあります。その場合は、最終結果(エラーまたは成功)を取得するために、INetwork_Start() を再コールする必要があります

SFBNetwork::Start()の再コール可能の通知を受けるには、クライアントは SFBNetwork::AddRetryCB() を介してコールバックを登録します。クライアントのコールバックが再開したとき、続いてコールするSFBNetwork::Start()が完了するという保証はないので、クライアントは AEE_NET_WOULDBLOCKを再度受け取る準備をしておく必要があります。

クライアントアプリケーションは、複数の「ネットワーク起動」トランザクションを同時に開始してはなりません。クライアントアプリケーションが複数の「ネットワーク起動」トランザクションを同時に必要とする場合は、トランザクションごとに複数の INetworkインスタンスを使用できます。

参照

BREW API INetwork_Start | SFBNetwork::AddRetryCB