Peer (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.Peer

```
public class Peer
extends Object
```
通信ノードとしてのピアを表現するクラス。以下の機能を有する。
- BaseTransportおよびBaseChannelTransportを生成する。
- このピア内で生成されたすべてのTransportを管理し、このPeerの終了時に生きているTransportを自動的に終了させる。
- LLNetに対するMSkipGraphのように、OverlayのbaseとなるOverlayを管理する。
- RPCInvokerを含むRPCの対象オブジェクトを管理する。

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

static class Peer.TransportTreeNode

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`Peer.TransportTreeNode`

フィールドのサマリー

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

static String RAW

static String WITH_FRAGMENTATION

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`RAW`
`static String`	`WITH_FRAGMENTATION`

コンストラクタのサマリー

コンストラクタ
修飾子コンストラクタと説明

protected Peer(PeerId peerId)

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`Peer(PeerId peerId)`

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`addBaseTransportGenerator(BaseTransportGenerator generator)` BaseTransportの生成コードをPeerに登録する。
`void`	`addFirstBaseTransportGenerator(BaseTransportGenerator generator)`
`void`	`concatPeerId2ThreadName()`
`void`	`execute(Runnable receiveTask)`
`void`	`fin()` このPeerオブジェクトを終了させる。
`List<Peer.TransportTreeNode>`	`genTransportTree()`
`List<Transport<?>>`	`getAllTransports()` 登録されたすべてのTransportのListを返す。
`Set<TransportIdPath>`	`getBaseOverlays()`
`BaseTransportMgr`	`getBaseTransportMgr()`
`IdResolver`	`getIdResolver()`
`static Peer`	`getInstance(PeerId peerId)` Peerオブジェクトを取得する。
`List<Transport<?>>`	`getMatchedTransport(TransportId... suffix)` 指定されたTransportId（複数可）をsuffixとして持つTransportのListを返す。
`List<Transport<?>>`	`getMatchedTransport(TransportIdPath suffix)` 指定されたTransportIdPathをsuffixとして持つTransportのListを返す。
`PeerId`	`getPeerId()`
`RPCIf`	`getRPCObject(ObjectId objId)`
`StatusRepo`	`getStatusRepo()`
`Transport<?>`	`getTransport(TransportIdPath transIdPath)` 指定されたTransportIdPathを持つTransportを返す。
`<E extends PeerLocator> ChannelTransport<E>`	`newBaseChannelTransport(E locator)` 指定されたPeerLocatorをEndpointとして持つBaseChannelTransportを生成する。
`<E extends PeerLocator> ChannelTransport<E>`	`newBaseChannelTransport(String desc, E locator)` 指定されたPeerLocatorをEndpointとして持つBaseChannelTransportを生成する。
`<E extends PeerLocator> ChannelTransport<E>`	`newBaseChannelTransport(String desc, TransportId transId, E locator)` 指定されたPeerLocatorをEndpointとして持つBaseChannelTransportを生成する。
`<E extends PeerLocator> Transport<E>`	`newBaseTransport(E locator)` 指定されたPeerLocatorをEndpointとして持つBaseTransportを生成する。
`<E extends PeerLocator> Transport<E>`	`newBaseTransport(String desc, E locator)` 指定されたPeerLocatorをEndpointとして持つBaseTransportを生成する。
`<E extends PeerLocator> Transport<E>`	`newBaseTransport(String desc, TransportId transId, E locator)` 指定されたPeerLocatorをEndpointとして持つBaseTransportを生成する。
`String`	`printTransportTree()`
`void`	`registerBaseOverlay(TransportIdPath transIdPath)`
`void`	`registerRPCObject(ObjectId objId, RPCIf obj)`
`void`	`registerTransport(TransportIdPath transIdPath, Transport<?> trans)`
`String`	`toString()`
`boolean`	`unregisterBaseOverlay(TransportIdPath transIdPath)`
`boolean`	`unregisterRPCObject(ObjectId objId, RPCIf obj)`
`boolean`	`unregisterTransport(TransportIdPath transIdPath, Transport<?> trans)`

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

- フィールドの詳細
  - RAW
```
public static final String RAW
```
    関連項目:
    
    定数フィールド値
  - WITH_FRAGMENTATION
```
public static final String WITH_FRAGMENTATION
```
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - Peer
```
protected Peer(PeerId peerId)
```
- メソッドの詳細
  - getInstance
```
public static Peer getInstance(PeerId peerId)
```
    Peerオブジェクトを取得する。
    初めてPeerオブジェクトがこのメソッド呼び出しにより取得される場合、または、すでに取得された Peerオブジェクトがfinメソッドの呼び出しにより、終了している場合は、新しくPeerオブジェクトが生成される。
    
    パラメータ:
    
    peerId - peerId
    
    戻り値:
    
    Peerオブジェクト
  - fin
```
public void fin()
```
    このPeerオブジェクトを終了させる。すべての未終了のTransportはこの時点で自動的に終了する。
  - getPeerId
```
public PeerId getPeerId()
```
  - getStatusRepo
```
public StatusRepo getStatusRepo()
                         throws IOException
```
    例外:
    
    IOException
  - getIdResolver
```
public IdResolver getIdResolver()
```
  - getBaseTransportMgr
```
public BaseTransportMgr getBaseTransportMgr()
```
  - addBaseTransportGenerator
```
public void addBaseTransportGenerator(BaseTransportGenerator generator)
```
    BaseTransportの生成コードをPeerに登録する。
    このメソッドは、新しくPeerLocatorとそのドライバであるRawTransportが追加された時に、 Peerに対して、BaseTransportの生成方法を教える際に用いる。
    
    パラメータ:
    
    generator - BaseTransportの生成コード
  - addFirstBaseTransportGenerator
```
public void addFirstBaseTransportGenerator(BaseTransportGenerator generator)
```
  - newBaseTransport
```
public <E extends PeerLocator> Transport<E> newBaseTransport(E locator)
                                                      throws IOException,
                                                             IdConflictException
```
    指定されたPeerLocatorをEndpointとして持つBaseTransportを生成する。
    BaseTransportの生成はデフォルトの設定で行われる。また、生成後のBaseTransportのTransportIdにはデフォルトの値がセットされる。 BaseTransportの生成手段がない場合はnullが返される。
    
    型パラメータ:
    
    E - the type of peer locator.
    
    パラメータ:
    
    locator - PeerLocator
    
    戻り値:
    
    指定されたPeerLocatorをEndpointとして持つBaseTransport
    
    例外:
    
    IOException - BaseTransportの生成中にI/Oエラーが発生した場合
    
    IdConflictException - 指定したtransIdが他とコンフリクトを起こした場合
  - newBaseTransport
```
public <E extends PeerLocator> Transport<E> newBaseTransport(String desc,
                                                             E locator)
                                                      throws IOException,
                                                             IdConflictException
```
    指定されたPeerLocatorをEndpointとして持つBaseTransportを生成する。
    descはBaseTransportを生成する際に補助情報として用いられるが、これは、 BaseTransportを生成するロジック内で解釈される文字列情報であり、PeerLocator毎に規定される。 descにnullがセットされた場合はデフォルト値として解釈される。生成後のBaseTransportのTransportIdにはデフォルトの値がセットされる。 BaseTransportの生成手段がない場合はnullが返される。
    
    型パラメータ:
    
    E - the type of peer locator.
    
    パラメータ:
    
    desc - BaseTransportを生成する際に与える補助情報
    
    locator - PeerLocator
    
    戻り値:
    
    指定されたPeerLocatorをEndpointとして持つBaseTransport
    
    例外:
    
    IOException - BaseTransportの生成中にI/Oエラーが発生した場合
    
    IdConflictException - 指定したtransIdが他とコンフリクトを起こした場合
  - newBaseTransport
```
public <E extends PeerLocator> Transport<E> newBaseTransport(String desc,
                                                             TransportId transId,
                                                             E locator)
                                                      throws IOException,
                                                             IdConflictException
```
    指定されたPeerLocatorをEndpointとして持つBaseTransportを生成する。
    descはBaseTransportを生成する際に補助情報として用いられるが、これは、 BaseTransportを生成するロジック内で解釈される文字列情報であり、PeerLocator毎に規定される。指定されたtransIdが、生成後のBaseTransportのTransportIdとしてセットされる。 descおよびtransIdにnullがセットされた場合はデフォルト値として解釈される。 BaseTransportの生成手段がない場合はnullが返される。
    
    型パラメータ:
    
    E - the type of peer locator.
    
    パラメータ:
    
    desc - BaseTransportを生成する際に与える補助情報
    
    transId - 生成後のBaseTransportにつけるTransportId
    
    locator - PeerLocator
    
    戻り値:
    
    指定されたPeerLocatorをEndpointとして持つBaseTransport
    
    例外:
    
    IOException - BaseTransportの生成中にI/Oエラーが発生した場合
    
    IdConflictException - 指定したtransIdが他とコンフリクトを起こした場合
  - newBaseChannelTransport
```
public <E extends PeerLocator> ChannelTransport<E> newBaseChannelTransport(E locator)
                                                                    throws IOException,
                                                                           IdConflictException
```
    指定されたPeerLocatorをEndpointとして持つBaseChannelTransportを生成する。
    BaseChannelTransportの生成はデフォルトの設定で行われる。また、生成後のBaseChannelTransportのTransportIdにはデフォルトの値がセットされる。 BaseChannelTransportの生成手段がない場合はnullが返される。
    
    型パラメータ:
    
    E - the type of peer locator.
    
    パラメータ:
    
    locator - PeerLocator
    
    戻り値:
    
    指定されたPeerLocatorをEndpointとして持つBaseTransport
    
    例外:
    
    IOException - BaseChannelTransportの生成中にI/Oエラーが発生した場合
    
    IdConflictException - 指定したtransIdが他とコンフリクトを起こした場合
  - newBaseChannelTransport
```
public <E extends PeerLocator> ChannelTransport<E> newBaseChannelTransport(String desc,
                                                                           E locator)
                                                                    throws IOException,
                                                                           IdConflictException
```
    指定されたPeerLocatorをEndpointとして持つBaseChannelTransportを生成する。
    descはBaseChannelTransportを生成する際に補助情報として用いられるが、これは、 BaseChannelTransportを生成するロジック内で解釈される文字列情報であり、PeerLocator毎に規定される。 descにnullがセットされた場合はデフォルト値として解釈される。生成後のBaseChannelTransportのTransportIdにはデフォルトの値がセットされる。 BaseChannelTransportの生成手段がない場合はnullが返される。
    
    型パラメータ:
    
    E - the type of peer locator.
    
    パラメータ:
    
    desc - base channel transport description.
    
    locator - the locator.
    
    戻り値:
    
    the peer locator.
    
    例外:
    
    IOException - BaseChannelTransportの生成中にI/Oエラーが発生した場合
    
    IdConflictException - 指定したtransIdが他とコンフリクトを起こした場合
  - newBaseChannelTransport
```
public <E extends PeerLocator> ChannelTransport<E> newBaseChannelTransport(String desc,
                                                                           TransportId transId,
                                                                           E locator)
                                                                    throws IOException,
                                                                           IdConflictException
```
    指定されたPeerLocatorをEndpointとして持つBaseChannelTransportを生成する。
    descはBaseChannelTransportを生成する際に補助情報として用いられるが、これは、 BaseChannelTransportを生成するロジック内で解釈される文字列情報であり、PeerLocator毎に規定される。指定されたtransIdが、生成後のBaseChannelTransportのTransportIdとしてセットされる。 descおよびtransIdにnullがセットされた場合はデフォルト値として解釈される。 BaseChannelTransportの生成手段がない場合はnullが返される。
    
    型パラメータ:
    
    E - the type of peer locator.
    
    パラメータ:
    
    desc - BaseChannelTransportを生成する際に与える補助情報
    
    transId - 生成後のBaseChannelTransportにつけるTransportId
    
    locator - PeerLocator
    
    戻り値:
    
    指定されたPeerLocatorをEndpointとして持つBaseChannelTransport
    
    例外:
    
    IOException - BaseChannelTransportの生成中にI/Oエラーが発生した場合
    
    IdConflictException - 指定したtransIdが他とコンフリクトを起こした場合
  - registerTransport
```
public void registerTransport(TransportIdPath transIdPath,
                              Transport<?> trans)
                       throws IdConflictException
```
    例外:
    
    IdConflictException
  - unregisterTransport
```
public boolean unregisterTransport(TransportIdPath transIdPath,
                                   Transport<?> trans)
```
  - getAllTransports
```
public List<Transport<?>> getAllTransports()
```
    登録されたすべてのTransportのListを返す。
    
    戻り値:
    
    登録されたすべてのTransportのList
  - getTransport
```
public Transport<?> getTransport(TransportIdPath transIdPath)
```
    指定されたTransportIdPathを持つTransportを返す。存在しない場合はnullが返される。
    
    パラメータ:
    
    transIdPath - TransportIdPath
    
    戻り値:
    
    TransportIdPathを持つTransport。存在しない場合はnull
  - getMatchedTransport
```
public List<Transport<?>> getMatchedTransport(TransportId... suffix)
```
    指定されたTransportId（複数可）をsuffixとして持つTransportのListを返す。
    
    パラメータ:
    
    suffix - suffixとして指定されたTransportId（複数可）
    
    戻り値:
    
    指定されたTransportId（複数可）をsuffixとして持つTransportのList
  - getMatchedTransport
```
public List<Transport<?>> getMatchedTransport(TransportIdPath suffix)
```
    指定されたTransportIdPathをsuffixとして持つTransportのListを返す。
    
    パラメータ:
    
    suffix - suffixとして指定されたTransportIdPath
    
    戻り値:
    
    指定されたTransportIdPathをsuffixとして持つTransportのList
  - genTransportTree
```
public List<Peer.TransportTreeNode> genTransportTree()
```
  - printTransportTree
```
public String printTransportTree()
```
  - registerBaseOverlay
```
public void registerBaseOverlay(TransportIdPath transIdPath)
```
  - unregisterBaseOverlay
```
public boolean unregisterBaseOverlay(TransportIdPath transIdPath)
```
  - getBaseOverlays
```
public Set<TransportIdPath> getBaseOverlays()
```
  - registerRPCObject
```
public void registerRPCObject(ObjectId objId,
                              RPCIf obj)
                       throws IdConflictException
```
    例外:
    
    IdConflictException
  - unregisterRPCObject
```
public boolean unregisterRPCObject(ObjectId objId,
                                   RPCIf obj)
```
  - getRPCObject
```
public RPCIf getRPCObject(ObjectId objId)
```
  - execute
```
public void execute(Runnable receiveTask)
             throws RejectedExecutionException
```
    例外:
    
    RejectedExecutionException
  - concatPeerId2ThreadName
```
public void concatPeerId2ThreadName()
```
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス Peer

ネストされたクラスのサマリー

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

RAW

WITH_FRAGMENTATION

コンストラクタの詳細

Peer

メソッドの詳細

getInstance

fin

getPeerId

getStatusRepo

getIdResolver

getBaseTransportMgr

addBaseTransportGenerator

addFirstBaseTransportGenerator

newBaseTransport

newBaseTransport

newBaseTransport

newBaseChannelTransport

newBaseChannelTransport

newBaseChannelTransport

registerTransport

unregisterTransport

getAllTransports

getTransport

getMatchedTransport

getMatchedTransport

genTransportTree

printTransportTree

registerBaseOverlay

unregisterBaseOverlay

getBaseOverlays

registerRPCObject

unregisterRPCObject

getRPCObject

execute

concatPeerId2ThreadName

toString