SAMv1Handler (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.sam.SAMHandler
- - net.i2p.sam.SAMv1Handler

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

Handler, SAMDatagramReceiver, SAMRawReceiver, SAMStreamReceiver

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

SAMv2Handler, SAMv3Handler
```
class SAMv1Handler
extends SAMHandler
implements SAMRawReceiver, SAMDatagramReceiver, SAMStreamReceiver
```
Class able to handle a SAM version 1 client connections.

作成者:

human

フィールドの概要

フィールド
修飾子とタイプ	フィールド	説明
`protected long`	`_id`
`protected SAMMessageSess`	`datagramSession`
`protected SAMMessageSess`	`rawSession`
`protected static java.lang.String`	`SESSION_ERROR`
`protected SAMStreamSession`	`streamSession`

クラスから継承されたフィールド net.i2p.sam.SAMHandler
_log, bridge, i2cpProps, socket, stopHandler, stopLock, thread, verMajor, verMinor

コンストラクタの概要

コンストラクタ
コンストラクタ	説明
`SAMv1Handler(java.nio.channels.SocketChannel s, int verMajor, int verMinor, java.util.Properties i2cpProps, SAMBridge parent)`	Create a new SAM version 1 handler.
`SAMv1Handler(java.nio.channels.SocketChannel s, int verMajor, int verMinor, SAMBridge parent)`	Create a new SAM version 1 handler.

メソッドの概要

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`protected static java.lang.String`	`createMessageString(java.lang.String msg)`	Create a string to be appended to a status.
`protected boolean`	`execDatagramMessage(java.lang.String opcode, java.util.Properties props)`
`protected boolean`	`execDestMessage(java.lang.String opcode, java.util.Properties props)`
`protected boolean`	`execNamingMessage(java.lang.String opcode, java.util.Properties props)`
`protected boolean`	`execRawMessage(java.lang.String opcode, java.util.Properties props)`
`protected boolean`	`execSessionMessage(java.lang.String opcode, java.util.Properties props)`
`protected boolean`	`execStreamClose(java.util.Properties props)`
`protected boolean`	`execStreamConnect(java.util.Properties props)`
`protected boolean`	`execStreamMessage(java.lang.String opcode, java.util.Properties props)`
`protected boolean`	`execStreamSend(java.util.Properties props)`
`protected SAMMessageSess`	`getDatagramSession()`
`protected SAMMessageSess`	`getRawSession()`
`protected SAMStreamSession`	`getStreamSession()`
`void`	`handle()`	Actually handle the SAM protocol.
`void`	`notifyStreamDisconnection(int id, java.lang.String result, java.lang.String msg)`	Notify that a connection has been closed FIXME: this interface should be cleaner
`void`	`notifyStreamIncomingConnection(int id, Destination d)`	Notify about a new incoming connection
`void`	`notifyStreamOutgoingConnection(int id, java.lang.String result, java.lang.String msg)`	Notify about a new outgoing connection
`void`	`notifyStreamSendBufferFree(int id)`	Notifies that the outwards buffer is free for writing
`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.
`void`	`receiveStreamBytes(int id, java.nio.ByteBuffer data)`	Transmit a byte array from I2P to a SAM client.
`void`	`stopDatagramReceiving()`	Stop receiving data.
`void`	`stopRawReceiving()`	Stop receiving data.
`void`	`stopStreamReceiving()`	Stop receiving data.
`void`	`streamSendAnswer(int id, java.lang.String result, java.lang.String bufferState)`	Sends the result of a stream send operation
`boolean`	`verifVersion()`
`protected boolean`	`writeString(java.lang.String s, java.lang.String msg)`	Write a string and message, escaping the message.

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

クラスから継承されたメソッド net.i2p.sam.SAMHandler
closeClientSocket, getClientSocket, getWriteLock, run, shouldStop, startHandling, stopHandling, toString, writeBytes, writeString, writeString

- フィールドの詳細
  - rawSession
```
protected SAMMessageSess rawSession
```
  - datagramSession
```
protected SAMMessageSess datagramSession
```
  - streamSession
```
protected SAMStreamSession streamSession
```
  - _id
```
protected final long _id
```
  - SESSION_ERROR
```
protected static final java.lang.String SESSION_ERROR
```
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - SAMv1Handler
```
public SAMv1Handler(java.nio.channels.SocketChannel s,
                    int verMajor,
                    int verMinor,
                    SAMBridge parent)
             throws SAMException,
                    java.io.IOException
```
    Create a new SAM version 1 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
    
    パラメータ:
    
    s - Socket attached to a SAM client
    
    verMajor - SAM major version to manage (should be 1)
    
    verMinor - SAM minor version to manage
    
    例外:
    
    SAMException
    
    java.io.IOException
  - SAMv1Handler
```
public SAMv1Handler(java.nio.channels.SocketChannel s,
                    int verMajor,
                    int verMinor,
                    java.util.Properties i2cpProps,
                    SAMBridge parent)
             throws SAMException,
                    java.io.IOException
```
    Create a new SAM version 1 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
    
    パラメータ:
    
    s - Socket attached to a SAM client
    
    verMajor - SAM major version to manage (should be 1)
    
    verMinor - SAM minor version to manage
    
    i2cpProps - properties to configure the I2CP connection (host, port, etc)
    
    例外:
    
    SAMException
    
    java.io.IOException
- メソッドの詳細
  - getRawSession
```
protected final SAMMessageSess getRawSession()
```
  - getDatagramSession
```
protected final SAMMessageSess getDatagramSession()
```
  - getStreamSession
```
protected final SAMStreamSession getStreamSession()
```
  - verifVersion
```
public boolean verifVersion()
```
  - handle
```
public void handle()
```
    クラスからコピーされた説明: SAMHandler
    
    Actually handle the SAM protocol.
    
    定義:
    
    handle クラス内 SAMHandler
  - execSessionMessage
```
protected boolean execSessionMessage(java.lang.String opcode,
                                     java.util.Properties props)
```
  - execDestMessage
```
protected boolean execDestMessage(java.lang.String opcode,
                                  java.util.Properties props)
```
  - execNamingMessage
```
protected boolean execNamingMessage(java.lang.String opcode,
                                    java.util.Properties props)
```
  - execDatagramMessage
```
protected boolean execDatagramMessage(java.lang.String opcode,
                                      java.util.Properties props)
```
  - execRawMessage
```
protected boolean execRawMessage(java.lang.String opcode,
                                 java.util.Properties props)
```
  - execStreamMessage
```
protected boolean execStreamMessage(java.lang.String opcode,
                                    java.util.Properties props)
```
  - execStreamSend
```
protected boolean execStreamSend(java.util.Properties props)
```
  - execStreamConnect
```
protected boolean execStreamConnect(java.util.Properties props)
```
  - execStreamClose
```
protected boolean execStreamClose(java.util.Properties props)
```
  - 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
  - stopRawReceiving
```
public void stopRawReceiving()
```
    インタフェースからコピーされた説明: SAMRawReceiver
    
    Stop receiving data.
    
    定義:
    
    stopRawReceiving インタフェース内 SAMRawReceiver
  - 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
  - stopDatagramReceiving
```
public void stopDatagramReceiving()
```
    インタフェースからコピーされた説明: SAMDatagramReceiver
    
    Stop receiving data.
    
    定義:
    
    stopDatagramReceiving インタフェース内 SAMDatagramReceiver
  - streamSendAnswer
```
public void streamSendAnswer(int id,
                             java.lang.String result,
                             java.lang.String bufferState)
                      throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Sends the result of a stream send operation
    
    定義:
    
    streamSendAnswer インタフェース内 SAMStreamReceiver
    
    パラメータ:
    
    id - Stream ID
    
    result - information
    
    bufferState - state of the buffer
    
    例外:
    
    java.io.IOException
  - notifyStreamSendBufferFree
```
public void notifyStreamSendBufferFree(int id)
                                throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Notifies that the outwards buffer is free for writing
    
    定義:
    
    notifyStreamSendBufferFree インタフェース内 SAMStreamReceiver
    
    パラメータ:
    
    id - stream ID
    
    例外:
    
    java.io.IOException
  - notifyStreamIncomingConnection
```
public void notifyStreamIncomingConnection(int id,
                                           Destination d)
                                    throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Notify about a new incoming connection
    
    定義:
    
    notifyStreamIncomingConnection インタフェース内 SAMStreamReceiver
    
    パラメータ:
    
    id - New connection id
    
    d - Destination
    
    例外:
    
    java.io.IOException
  - notifyStreamOutgoingConnection
```
public void notifyStreamOutgoingConnection(int id,
                                           java.lang.String result,
                                           java.lang.String msg)
                                    throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Notify about a new outgoing connection
    
    定義:
    
    notifyStreamOutgoingConnection インタフェース内 SAMStreamReceiver
    
    パラメータ:
    
    msg - may be null
    
    id - New connection id
    
    result - message result
    
    例外:
    
    java.io.IOException
  - createMessageString
```
protected static java.lang.String createMessageString(java.lang.String msg)
```
    Create a string to be appended to a status.
    
    パラメータ:
    
    msg - may be null
    
    戻り値:
    
    non-null, "" if msg is null, MESSAGE=msg or MESSAGE="msg a b c" with leading space if msg is non-null
    
    導入されたバージョン:
    
    0.9.20
  - writeString
```
protected boolean writeString(java.lang.String s,
                              java.lang.String msg)
```
    Write a string and message, escaping the message. Writes s + createMessageString(msg) + \n
    
    パラメータ:
    
    s - The string, non-null
    
    導入されたバージョン:
    
    0.9.25
  - receiveStreamBytes
```
public void receiveStreamBytes(int id,
                               java.nio.ByteBuffer data)
                        throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Transmit a byte array from I2P to a SAM client.
    
    定義:
    
    receiveStreamBytes インタフェース内 SAMStreamReceiver
    
    パラメータ:
    
    id - Connection id
    
    data - Byte array to be received
    
    例外:
    
    java.io.IOException
  - notifyStreamDisconnection
```
public void notifyStreamDisconnection(int id,
                                      java.lang.String result,
                                      java.lang.String msg)
                               throws java.io.IOException
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Notify that a connection has been closed FIXME: this interface should be cleaner
    
    定義:
    
    notifyStreamDisconnection インタフェース内 SAMStreamReceiver
    
    パラメータ:
    
    msg - may be null
    
    id - Connection id
    
    result - Disconnection reason ("OK" or something else)
    
    例外:
    
    java.io.IOException
  - stopStreamReceiving
```
public void stopStreamReceiving()
```
    インタフェースからコピーされた説明: SAMStreamReceiver
    
    Stop receiving data.
    
    定義:
    
    stopStreamReceiving インタフェース内 SAMStreamReceiver

クラス SAMv1Handler

フィールドの概要

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

コンストラクタの概要

メソッドの概要

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

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

フィールドの詳細

rawSession

datagramSession

streamSession

_id

SESSION_ERROR

コンストラクタの詳細

SAMv1Handler

SAMv1Handler

メソッドの詳細

getRawSession

getDatagramSession

getStreamSession

verifVersion

handle

execSessionMessage

execDestMessage

execNamingMessage

execDatagramMessage

execRawMessage

execStreamMessage

execStreamSend

execStreamConnect

execStreamClose

receiveRawBytes

stopRawReceiving

receiveDatagramBytes

stopDatagramReceiving

streamSendAnswer

notifyStreamSendBufferFree

notifyStreamIncomingConnection

notifyStreamOutgoingConnection

createMessageString

writeString

receiveStreamBytes

notifyStreamDisconnection

stopStreamReceiving