SAMMessageSession (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.sam.SAMMessageSession

すべての実装されたインタフェース:

java.io.Closeable, java.lang.AutoCloseable, SAMMessageSess

直系の既知のサブクラス:

SAMDatagramSession, SAMRawSession
```
abstract class SAMMessageSession
extends java.lang.Object
implements SAMMessageSess
```
Base abstract class for SAM message-based sessions.

作成者:

human

フィールドの概要

フィールド
修飾子とタイプフィールド説明

protected boolean _isOwnSession

protected Log _log

フィールド
修飾子とタイプ	フィールド	説明
`protected boolean`	`_isOwnSession`
`protected Log`	`_log`

コンストラクタの概要

コンストラクタ
修飾子	コンストラクタ	説明
`protected`	`SAMMessageSession(java.io.InputStream destStream, java.util.Properties props)`	Initialize a new SAM message-based session.
`protected`	`SAMMessageSession(java.lang.String dest, java.util.Properties props)`	Initialize a new SAM message-based session.
`protected`	`SAMMessageSession(I2PSession sess, int listenProtocol, int listenPort)`	Initialize a new SAM message-based session using an existing I2PSession.

メソッドの概要

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`void`	`close()`	Close a SAM message-based session.
`Destination`	`getDestination()`	Get the SAM message-based session Destination.
`protected I2PSession`	`getI2PSession()`	Get the I2PSession object used by the SAM message-based session.
`int`	`getListenPort()`
`int`	`getListenProtocol()`
`protected abstract void`	`messageReceived(byte[] msg, int proto, int fromPort, int toPort)`	Handle a new received message
`abstract boolean`	`sendBytes(java.lang.String dest, byte[] data, int proto, int fromPort, int toPort)`	Send bytes through a SAM message-based session.
`protected boolean`	`sendBytesThroughMessageSession(java.lang.String dest, byte[] data, int proto, int fromPort, int toPort)`	Actually send bytes through the SAM message-based session I2PSession (er...).
`protected boolean`	`sendBytesThroughMessageSession(java.lang.String dest, byte[] data, int proto, int fromPort, int toPort, boolean sendLeaseSet, int sendTags, int tagThreshold, int expiration)`	Actually send bytes through the SAM message-based session I2PSession, using per-message extended options.
`protected abstract void`	`shutDown()`	Do whatever is needed to shutdown the SAM session
`void`	`start()`	Start a SAM message-based session.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド net.i2p.sam.SAMMessageSess
sendBytes

- フィールドの詳細
  - _log
```
protected final Log _log
```
  - _isOwnSession
```
protected final boolean _isOwnSession
```
- コンストラクタの詳細
  - SAMMessageSession
```
protected SAMMessageSession(java.lang.String dest,
                            java.util.Properties props)
                     throws java.io.IOException,
                            DataFormatException,
                            I2PSessionException
```
    Initialize a new SAM message-based session.
    
    パラメータ:
    
    dest - Base64-encoded destination and private keys (same format as PrivateKeyFile)
    
    props - Properties to setup the I2P session
    
    例外:
    
    java.io.IOException
    
    DataFormatException
    
    I2PSessionException
  - SAMMessageSession
```
protected SAMMessageSession(java.io.InputStream destStream,
                            java.util.Properties props)
                     throws java.io.IOException,
                            DataFormatException,
                            I2PSessionException
```
    Initialize a new SAM message-based session.
    
    パラメータ:
    
    destStream - Input stream containing the destination and private keys (same format as PrivateKeyFile)
    
    props - Properties to setup the I2P session
    
    例外:
    
    java.io.IOException
    
    DataFormatException
    
    I2PSessionException
  - SAMMessageSession
```
protected SAMMessageSession(I2PSession sess,
                            int listenProtocol,
                            int listenPort)
                     throws java.io.IOException,
                            DataFormatException,
                            I2PSessionException
```
    Initialize a new SAM message-based session using an existing I2PSession.
    
    例外:
    
    java.io.IOException
    
    DataFormatException
    
    I2PSessionException
    
    導入されたバージョン:
    
    0.9.25
- メソッドの詳細
  - start
```
public void start()
```
    インタフェースからコピーされた説明: SAMMessageSess
    
    Start a SAM message-based session. MUST be called after constructor.
    
    定義:
    
    start インタフェース内 SAMMessageSess
  - getDestination
```
public Destination getDestination()
```
    Get the SAM message-based session Destination.
    
    定義:
    
    getDestination インタフェース内 SAMMessageSess
    
    戻り値:
    
    The SAM message-based session Destination.
  - getListenProtocol
```
public int getListenProtocol()
```
    定義:
    
    getListenProtocol インタフェース内 SAMMessageSess
    
    導入されたバージョン:
    
    0.9.25
  - getListenPort
```
public int getListenPort()
```
    定義:
    
    getListenPort インタフェース内 SAMMessageSess
    
    導入されたバージョン:
    
    0.9.25
  - sendBytes
```
public abstract boolean sendBytes(java.lang.String dest,
                                  byte[] data,
                                  int proto,
                                  int fromPort,
                                  int toPort)
                           throws DataFormatException,
                                  I2PSessionException
```
    Send bytes through a SAM message-based session.
    
    定義:
    
    sendBytes インタフェース内 SAMMessageSess
    
    パラメータ:
    
    dest - Destination
    
    data - Bytes to be sent
    
    戻り値:
    
    True if the data was sent, false otherwise
    
    例外:
    
    DataFormatException - on unknown / bad dest
    
    I2PSessionException - on serious error, probably session closed
  - sendBytesThroughMessageSession
```
protected boolean sendBytesThroughMessageSession(java.lang.String dest,
                                                 byte[] data,
                                                 int proto,
                                                 int fromPort,
                                                 int toPort)
                                          throws DataFormatException,
                                                 I2PSessionException
```
    Actually send bytes through the SAM message-based session I2PSession (er...).
    
    パラメータ:
    
    dest - Destination
    
    data - Bytes to be sent
    
    proto - I2CP protocol
    
    fromPort - I2CP from port
    
    toPort - I2CP to port
    
    戻り値:
    
    True if the data was sent, false otherwise
    
    例外:
    
    DataFormatException - on unknown / bad dest
    
    I2PSessionException - on serious error, probably session closed
  - sendBytesThroughMessageSession
```
protected boolean sendBytesThroughMessageSession(java.lang.String dest,
                                                 byte[] data,
                                                 int proto,
                                                 int fromPort,
                                                 int toPort,
                                                 boolean sendLeaseSet,
                                                 int sendTags,
                                                 int tagThreshold,
                                                 int expiration)
                                          throws DataFormatException,
                                                 I2PSessionException
```
    Actually send bytes through the SAM message-based session I2PSession, using per-message extended options. For efficiency, use the method without all the extra options if they are all defaults.
    
    パラメータ:
    
    dest - Destination
    
    data - Bytes to be sent
    
    proto - I2CP protocol
    
    fromPort - I2CP from port
    
    toPort - I2CP to port
    
    sendLeaseSet - true is the usual setting and the I2CP default
    
    sendTags - 0 to leave as default
    
    tagThreshold - 0 to leave as default
    
    expiration - SECONDS from now, NOT absolute time, 0 to leave as default
    
    戻り値:
    
    True if the data was sent, false otherwise
    
    例外:
    
    DataFormatException - on unknown / bad dest
    
    I2PSessionException - on serious error, probably session closed
    
    導入されたバージョン:
    
    0.9.24
  - close
```
public void close()
```
    Close a SAM message-based session.
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
    
    定義:
    
    close インタフェース内 java.io.Closeable
    
    定義:
    
    close インタフェース内 SAMMessageSess
  - messageReceived
```
protected abstract void messageReceived(byte[] msg,
                                        int proto,
                                        int fromPort,
                                        int toPort)
```
    Handle a new received message
    
    パラメータ:
    
    msg - Message payload
  - shutDown
```
protected abstract void shutDown()
```
    Do whatever is needed to shutdown the SAM session
  - getI2PSession
```
protected I2PSession getI2PSession()
```
    Get the I2PSession object used by the SAM message-based session.
    
    戻り値:
    
    The I2PSession of the SAM message-based session

クラス SAMMessageSession

フィールドの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド net.i2p.sam.SAMMessageSess

フィールドの詳細

_log

_isOwnSession

コンストラクタの詳細

SAMMessageSession

SAMMessageSession

SAMMessageSession

メソッドの詳細

start

getDestination

getListenProtocol

getListenPort

sendBytes

sendBytesThroughMessageSession

sendBytesThroughMessageSession

close

messageReceived

shutDown

getI2PSession