NTT DOCOMO and Hitachi Kokusai Electric Know-how & Confidential

com.docomo_um.module.net
クラス PacketSession

java.lang.Object
  上位を拡張 com.docomo_um.module.net.Session
      上位を拡張 com.docomo_um.module.net.PacketSession

public final class PacketSession
extends Session

パケット通信の接続を表すクラスです。

パケット発信時は、PacketController.createSession(String) の引数に接続先APNを設定して本クラスのインスタンスを生成し、 setPDPTypeInfo(PDPTypeInfo) を使用してPDP情報を設定した後、send() をコールします。
パケット着信時は、ModemControllerListener.onReceived(ModemController, Session)の第2引数に APN情報のみ設定された本クラスのインスタンスが渡されるので、setPDPTypeInfo(PDPTypeInfo) を使用してPDP情報を設定した後、 receive() をコールします。
接続を切断する場合は、disconnect() をコールします。

関連項目:
Session, PacketController

フィールドの概要
 
クラス com.docomo_um.module.net.Session から継承されたフィールド
CONNECTION_STATUS_CONNECT, CONNECTION_STATUS_DISCONNECT, CONNECTION_STATUS_INCOMING_CALL, CONNECTION_STATUS_OUTGOING_CALL
 
メソッドの概要
 void disconnect()
          切断します。
 PDPTypeInfo getPDPTypeInfo()
          PDPタイプを取得します。
 void receive()
          着信時に接続します。
 void send()
          発信します。
 void setPDPTypeInfo(PDPTypeInfo pdpType)
          パケット通信で使用するPDPTypeを設定します。
 
クラス com.docomo_um.module.net.Session から継承されたメソッド
getConnectedStatus, getDestination
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait
 

メソッドの詳細

send

public void send()
          throws SessionException,
                 CommunicationFailureException,
                 RegulationException,
                 IllegalSettingException,
                 ExternalStatusException,
                 DeviceException
発信します。

setPDPTypeInfo(PDPTypeInfo)で設定したPDPTypeInfoで接続をします。 PDPTypeInfoを設定していない状態で本メソッドをコールした場合、IllegalSettingExceptionが発生します。

本セッションが切断状態(Session.CONNECTION_STATUS_DISCONNECT)以外の状態で本メソッドをコールした場合、何もしません。 本セッション以外のセッションにおいて、既に発信中(Session.CONNECTION_STATUS_OUTGOING_CALL)、着信中(Session.CONNECTION_STATUS_INCOMING_CALL)、 接続中(Session.CONNECTION_STATUS_CONNECT)のパケット回線がある場合に本メソッドをコールすると、IllegalStateExceptionが発生します。

定義:
クラス Session 内の send
例外:
java.lang.IllegalStateException - 発信が行えない状態で本メソッドをコールした場合に発生します。
SessionException - 接続要求が拒否された場合など、正常に処理できなかった場合に発生します。
CommunicationFailureException - 通信異常の場合に発生します。
RegulationException - 規制による通信失敗の場合に発生します。
IllegalSettingException - PDPTypeInfoを設定していない状態で本メソッドをコールした場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、発信に失敗した場合に発生します。
DeviceException - デバイスの故障により、発信に失敗した場合に発生します。

receive

public void receive()
             throws SessionException,
                    CommunicationFailureException,
                    IllegalSettingException
着信時に接続します。

setPDPTypeInfo(PDPTypeInfo)で設定したPDPTypeInfoで接続をします。 setPDPTypeInfo(PDPTypeInfo)には、必ずPPPSettingInfoを設定してください。 PPPSettingInfoが設定されていない状態で本メソッドをコールした場合、IllegalSettingExceptionが発生します。

本セッションが着信中(Session.CONNECTION_STATUS_INCOMING_CALL)以外の状態で本メソッドをコールした場合、何もしません。 本セッション以外のセッションにおいて、既に接続中(Session.CONNECTION_STATUS_CONNECT)のパケット回線がある場合に本メソッドをコールすると、 IllegalStateExceptionが発生します。

定義:
クラス Session 内の receive
例外:
java.lang.IllegalStateException - 着信を受けられない状態で本メソッドをコールした場合に発生します。
SessionException - 内部エラーにより処理が中断した場合に発生します。
CommunicationFailureException - 通信異常の場合に発生します。
IllegalSettingException - PPPSettingInfoが設定されていない状態で本メソッドをコールした場合に発生します。

disconnect

public void disconnect()
                throws SessionException
切断します。

本セッションが切断状態(Session.CONNECTION_STATUS_DISCONNECT)で本メソッドを呼び出した場合、何もしません。

オーバーライド:
クラス Session 内の disconnect
例外:
SessionException - 内部エラーにより処理が中断した場合に発生します。

getPDPTypeInfo

public PDPTypeInfo getPDPTypeInfo()
PDPタイプを取得します。

setPDPTypeInfo(PDPTypeInfo)で設定していない場合、本メソッドはnullを返却します。

戻り値:
このインスタンスのPDPタイプを返します。

setPDPTypeInfo

public void setPDPTypeInfo(PDPTypeInfo pdpType)
パケット通信で使用するPDPTypeを設定します。

当該セッションのAPNに対応したPDP情報を設定します。

パラメータ:
pdpType - PDPタイプを指定します。IPを使用する場合はIPSettingInfo、PPPを使用する場合はPPPSettingInfoを指定します。
例外:
java.lang.NullPointerException - pdpTypeにnullを指定した場合に発生します。
java.lang.IllegalStateException - 回線が接続状態で本メソッドをコールした場合に発生します。

Copyright © 2013 NTT DOCOMO, INC. and Hitachi Kokusai Electric Inc. All Rights Reserved.