MasterSession (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.sam.SAMStreamSession
- - net.i2p.sam.SAMv3StreamSession
  - - net.i2p.sam.MasterSession

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

java.io.Closeable, java.lang.AutoCloseable, I2PSessionListener, I2PSessionMuxedListener, SAMDatagramReceiver, SAMMessageSess, SAMRawReceiver
```
class MasterSession
extends SAMv3StreamSession
implements SAMDatagramReceiver, SAMRawReceiver, SAMMessageSess, I2PSessionMuxedListener
```
A session that does nothing, but implements interfaces for raw, datagram, and streaming for convenience. We extend SAMv3StreamSession as we must have it set up the I2PSession, in case user adds a STREAM session (and he probably will). This session receives all data from I2P, but you can't send any data on it.

導入されたバージョン:

0.9.25

ネストされたクラスの概要
- クラスから継承されたネストされたクラス/インタフェース net.i2p.sam.SAMStreamSession
  SAMStreamSession.DisconnectListener, SAMStreamSession.SAMStreamSessionServer, SAMStreamSession.SAMStreamSessionSocketReader, SAMStreamSession.SAMv1StreamSessionSocketReader, SAMStreamSession.StreamSender

フィールドの概要
- クラスから継承されたフィールド net.i2p.sam.SAMStreamSession
  _isOwnSession, _log, canCreate, DEFAULT_FORCE_FLUSH, forceFlush, PROP_FORCE_FLUSH, recv, server, SOCKET_HANDLER_BUF_SIZE, socketMgr

コンストラクタの概要

コンストラクタ
コンストラクタ	説明
`MasterSession(java.lang.String nick, SAMv3DatagramServer dgServer, SAMv3Handler handler, java.util.Properties props)`	Build a Session according to information registered with the given nickname.

メソッドの概要

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`void`	`accept(SAMv3Handler handler, boolean verbose)`	Accept a single incoming STREAM on the socket stolen from the handler.
`java.lang.String`	`add(java.lang.String nick, java.lang.String style, java.util.Properties props)`	Add a session
`void`	`close()`	Close the master session Overridden to stop the acceptor.
`void`	`connect(SAMv3Handler handler, java.lang.String dest, java.util.Properties props)`	Connect the SAM STREAM session to the specified Destination for a single connection, using the socket stolen from the handler.
`void`	`disconnected(I2PSession session)`	Notify the client that the session has been terminated.
`void`	`errorOccurred(I2PSession session, java.lang.String message, java.lang.Throwable error)`	Notify the client that some error occurred.
`int`	`getListenPort()`
`int`	`getListenProtocol()`
`void`	`messageAvailable(I2PSession session, int msgId, long size)`	Will be called only if you register via setSessionListener() or addSessionListener().
`void`	`messageAvailable(I2PSession session, int msgId, long size, int proto, int fromPort, int toPort)`	Instruct the client that the given session has received a message Will be called only if you register via addMuxedSessionListener().
`void`	`receiveDatagramBytes(Destination sender, byte[] data, int proto, int fromPort, int toPort)`	Send a byte array to a SAM client.
`void`	`receiveRawBytes(byte[] data, int proto, int fromPort, int toPort)`	Send a byte array to a SAM client, without informations regarding the sender.
`java.lang.String`	`remove(java.lang.String nick, java.util.Properties props)`	Remove a session
`void`	`reportAbuse(I2PSession session, int severity)`	Instruct the client that the session specified seems to be under attack and that the client may wish to move its destination to another router.
`void`	`start()`	Overridden to start the acceptor.
`void`	`startForwardingIncoming(java.util.Properties props, boolean sendPorts)`	Forward sockets from I2P to the host/port provided.
`void`	`stopDatagramReceiving()`	Does nothing.
`void`	`stopForwardingIncoming()`	does nothing
`void`	`stopRawReceiving()`	Does nothing.

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

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

クラスから継承されたメソッド net.i2p.sam.SAMStreamSession
checkSocketHandlerId, closeConnection, connect, createSocketHandler, getDestination, getSocketReader, newSAMStreamSessionSocketReader, newStreamSender, removeSocketHandler, sendBytes, sendBytes, sendBytes, setReceiveLimit

クラスから継承されたメソッド net.i2p.sam.SAMv3StreamSession
getDB, getNick, getSocketServer, queueSocket

- コンストラクタの詳細
  - MasterSession
```
public MasterSession(java.lang.String nick,
                     SAMv3DatagramServer dgServer,
                     SAMv3Handler handler,
                     java.util.Properties props)
              throws java.io.IOException,
                     DataFormatException,
                     SAMException
```
    Build a Session according to information registered with the given nickname. Caller MUST call start().
    
    パラメータ:
    
    nick - nickname of the session
    
    例外:
    
    java.io.IOException
    
    DataFormatException
    
    SAMException
- メソッドの詳細
  - start
```
public void start()
```
    Overridden to start the acceptor.
    
    定義:
    
    start インタフェース内 SAMMessageSess
    
    オーバーライド:
    
    start クラス内 SAMStreamSession
  - add
```
public java.lang.String add(java.lang.String nick,
                            java.lang.String style,
                            java.util.Properties props)
```
    Add a session
    
    戻り値:
    
    null for success, or error message
  - remove
```
public java.lang.String remove(java.lang.String nick,
                               java.util.Properties props)
```
    Remove a session
    
    戻り値:
    
    null for success, or error message
  - receiveDatagramBytes
```
public void receiveDatagramBytes(Destination sender,
                                 byte[] data,
                                 int proto,
                                 int fromPort,
                                 int toPort)
                          throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMDatagramReceiver
    
    Send a byte array to a SAM client.
    
    定義:
    
    receiveDatagramBytes インタフェース内 SAMDatagramReceiver
    
    パラメータ:
    
    sender - Destination
    
    data - Byte array to be received
    
    proto - I2CP protocol
    
    fromPort - I2CP from port
    
    toPort - I2CP to port
    
    例外:
    
    java.io.IOException - always
  - stopDatagramReceiving
```
public void stopDatagramReceiving()
```
    Does nothing.
    
    定義:
    
    stopDatagramReceiving インタフェース内 SAMDatagramReceiver
  - receiveRawBytes
```
public void receiveRawBytes(byte[] data,
                            int proto,
                            int fromPort,
                            int toPort)
                     throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMRawReceiver
    
    Send a byte array to a SAM client, without informations regarding the sender.
    
    定義:
    
    receiveRawBytes インタフェース内 SAMRawReceiver
    
    パラメータ:
    
    data - Byte array to be received
    
    proto - I2CP protocol
    
    fromPort - I2CP from port
    
    toPort - I2CP to port
    
    例外:
    
    java.io.IOException - always
  - stopRawReceiving
```
public void stopRawReceiving()
```
    Does nothing.
    
    定義:
    
    stopRawReceiving インタフェース内 SAMRawReceiver
  - connect
```
public void connect(SAMv3Handler handler,
                    java.lang.String dest,
                    java.util.Properties props)
             throws I2PException
```
    クラスからコピーされた説明: SAMv3StreamSession
    
    Connect the SAM STREAM session to the specified Destination for a single connection, using the socket stolen from the handler.
    
    オーバーライド:
    
    connect クラス内 SAMv3StreamSession
    
    パラメータ:
    
    handler - The handler that communicates with the requesting client
    
    dest - Base64-encoded Destination to connect to
    
    props - Options to be used for connection
    
    例外:
    
    I2PException - always
  - accept
```
public void accept(SAMv3Handler handler,
                   boolean verbose)
            throws SAMException
```
    クラスからコピーされた説明: SAMv3StreamSession
    
    Accept a single incoming STREAM on the socket stolen from the handler. As of version 3.2 (0.9.24), multiple simultaneous accepts are allowed. Accepts and forwarding may not be done at the same time.
    
    オーバーライド:
    
    accept クラス内 SAMv3StreamSession
    
    パラメータ:
    
    handler - The handler that communicates with the requesting client
    
    verbose - If true, SAM will send the Base64-encoded peer Destination of an incoming socket as the first line of data sent to its client on the handler socket
    
    例外:
    
    SAMException - always
  - startForwardingIncoming
```
public void startForwardingIncoming(java.util.Properties props,
                                    boolean sendPorts)
                             throws SAMException
```
    クラスからコピーされた説明: SAMv3StreamSession
    
    Forward sockets from I2P to the host/port provided. Accepts and forwarding may not be done at the same time.
    
    オーバーライド:
    
    startForwardingIncoming クラス内 SAMv3StreamSession
    
    例外:
    
    SAMException - always
  - stopForwardingIncoming
```
public void stopForwardingIncoming()
```
    does nothing
    
    オーバーライド:
    
    stopForwardingIncoming クラス内 SAMv3StreamSession
  - getListenProtocol
```
public int getListenProtocol()
```
    定義:
    
    getListenProtocol インタフェース内 SAMMessageSess
    
    オーバーライド:
    
    getListenProtocol クラス内 SAMStreamSession
  - getListenPort
```
public int getListenPort()
```
    定義:
    
    getListenPort インタフェース内 SAMMessageSess
    
    オーバーライド:
    
    getListenPort クラス内 SAMStreamSession
  - close
```
public void close()
```
    Close the master session Overridden to stop the acceptor.
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
    
    定義:
    
    close インタフェース内 java.io.Closeable
    
    定義:
    
    close インタフェース内 SAMMessageSess
    
    オーバーライド:
    
    close クラス内 SAMv3StreamSession
  - disconnected
```
public void disconnected(I2PSession session)
```
    インタフェースからコピーされた説明: I2PSessionMuxedListener
    
    Notify the client that the session has been terminated. All registered listeners will be called.
    
    定義:
    
    disconnected インタフェース内 I2PSessionListener
    
    定義:
    
    disconnected インタフェース内 I2PSessionMuxedListener
  - errorOccurred
```
public void errorOccurred(I2PSession session,
                          java.lang.String message,
                          java.lang.Throwable error)
```
    インタフェースからコピーされた説明: I2PSessionMuxedListener
    
    Notify the client that some error occurred. All registered listeners will be called.
    
    定義:
    
    errorOccurred インタフェース内 I2PSessionListener
    
    定義:
    
    errorOccurred インタフェース内 I2PSessionMuxedListener
    
    error - can be null? or not?
  - messageAvailable
```
public void messageAvailable(I2PSession session,
                             int msgId,
                             long size)
```
    インタフェースからコピーされた説明: I2PSessionMuxedListener
    
    Will be called only if you register via setSessionListener() or addSessionListener(). And if you are doing that, just use I2PSessionListener. If you register via addSessionListener(), this will be called only for the proto(s) and toport(s) you register for. After this is called, the client should call receiveMessage(msgId). There is currently no method for the client to reject the message. If the client does not call receiveMessage() within a timeout period (currently 30 seconds), the session will delete the message and log an error.
    
    定義:
    
    messageAvailable インタフェース内 I2PSessionListener
    
    定義:
    
    messageAvailable インタフェース内 I2PSessionMuxedListener
    
    パラメータ:
    
    session - session to notify
    
    msgId - message number available
    
    size - size of the message - why it's a long and not an int is a mystery
  - messageAvailable
```
public void messageAvailable(I2PSession session,
                             int msgId,
                             long size,
                             int proto,
                             int fromPort,
                             int toPort)
```
    インタフェースからコピーされた説明: I2PSessionMuxedListener
    
    Instruct the client that the given session has received a message Will be called only if you register via addMuxedSessionListener(). Will be called only for the proto(s) and toport(s) you register for. After this is called, the client should call receiveMessage(msgId). There is currently no method for the client to reject the message. If the client does not call receiveMessage() within a timeout period (currently 30 seconds), the session will delete the message and log an error. Only one listener is called for a given message, even if more than one have registered. See I2PSessionDemultiplexer for details.
    
    定義:
    
    messageAvailable インタフェース内 I2PSessionMuxedListener
    
    パラメータ:
    
    session - session to notify
    
    msgId - message number available
    
    size - size of the message - why it's a long and not an int is a mystery
    
    proto - 1-254 or 0 for unspecified
    
    fromPort - 1-65535 or 0 for unspecified
    
    toPort - 1-65535 or 0 for unspecified
    
    導入されたバージョン:
    
    0.9.24
  - reportAbuse
```
public void reportAbuse(I2PSession session,
                        int severity)
```
    インタフェースからコピーされた説明: I2PSessionMuxedListener
    
    Instruct the client that the session specified seems to be under attack and that the client may wish to move its destination to another router. All registered listeners will be called. Unused. Not fully implemented.
    
    定義:
    
    reportAbuse インタフェース内 I2PSessionListener
    
    定義:
    
    reportAbuse インタフェース内 I2PSessionMuxedListener
    
    パラメータ:
    
    session - session to report abuse to
    
    severity - how bad the abuse is

クラス MasterSession

ネストされたクラスの概要

クラスから継承されたネストされたクラス/インタフェース net.i2p.sam.SAMStreamSession

フィールドの概要

クラスから継承されたフィールド net.i2p.sam.SAMStreamSession

コンストラクタの概要

メソッドの概要

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

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

クラスから継承されたメソッド net.i2p.sam.SAMStreamSession

クラスから継承されたメソッド net.i2p.sam.SAMv3StreamSession

コンストラクタの詳細

MasterSession

メソッドの詳細

start

add

remove

receiveDatagramBytes

stopDatagramReceiving

receiveRawBytes

stopRawReceiving

connect

accept

startForwardingIncoming

stopForwardingIncoming

getListenProtocol

getListenPort

close

disconnected

errorOccurred

messageAvailable

messageAvailable

reportAbuse