PeerRelayEvent (drasyl: General-Purpose Overlay Network Framework - Core Package 0.4.0 API)

java.lang.Object
- org.drasyl.event.PeerRelayEvent

All Implemented Interfaces:

Event, PeerEvent
```
public class PeerRelayEvent
extends Object
```
This event signals that communication with this peer is only possible by relaying messages via a super peer. If there is no connection to a super peer, no communication with this peer is possible.
This is an immutable object.

See Also:

PeerDirectEvent, NodeOnlineEvent, NodeOfflineEvent

Field Summary

Fields
Modifier and Type Field Description

protected Peer peer

Constructor Summary

Constructors
Constructor Description

PeerRelayEvent(Peer peer)
Deprecated, for removal: This API element is subject to removal in a future version.
Use of(Peer) instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`Peer`	`getPeer()`	Returns the peer to which this event refers.
`int`	`hashCode()`
`static PeerRelayEvent`	`of(Peer peer)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - peer
```
protected final Peer peer
```
- Constructor Detail
  - PeerRelayEvent
```
@Deprecated(since="0.4.0",
            forRemoval=true)
public PeerRelayEvent(Peer peer)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use of(Peer) instead.
    
    Throws:
    
    NullPointerException - if peer is null
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static PeerRelayEvent of(Peer peer)
```
    Throws:
    
    NullPointerException - if peer is null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getPeer
```
@NonNull
public Peer getPeer()
```
    Description copied from interface: PeerEvent
    
    Returns the peer to which this event refers.
    
    Specified by:
    
    getPeer in interface PeerEvent
    
    Returns:
    
    the peer to which this event refers.