P2PClientActor

This actor is responsible for creating a connection, relaying messages and closing a connection to our peer on the P2P network. This is the actor that directly interacts with the p2p network. It's responsibly is to deal with low level .TCP messages.

If the client receives a NetworkMessage, from a PeerMessageSender it serializes the message to it to a akka.util.ByteString and then sends it to the internal manager which streams the data to our peer on the Bitcoin network.

If the client receives a Tcp.Received message, it means we have received a message from our peer on the Bitcoin P2P network. This means we try to parse the bytes into a NetworkMessage. If we successfully parse the message we relay that message to the PeerMessageSender that created the Client Actor.

In this class you will see a 'unalignedBytes' value passed around in a lot of methods. This is because we cannot assume that a Bitcoin P2P message aligns with a TCP packet. For instance, a large block message (up to 4MB in size) CANNOT fit in a single TCP packet. This means we must cache the bytes and wait for the rest of them to be sent.

initPeerMsgHandlerReceiver: The place we send messages that we successfully parsed from our peer on the P2P network. This is mostly likely a org.bitcoins.node.networking.peer.PeerMessageSender

Linear Supertypes

Serializable, Serializable, Product, Equals, P2PLogger, Actor, AnyRef, Any

Instance Constructors

new P2PClientActor(peer: Peer, initPeerMsgHandlerReceiver: PeerMessageReceiver)(implicit config: NodeAppConfig)

initPeerMsgHandlerReceiver
The place we send messages that we successfully parsed from our peer on the P2P network. This is mostly likely a org.bitcoins.node.networking.peer.PeerMessageSender

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def aroundPostRestart(reason: Throwable): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPostStop(): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPreStart(): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit val context: ActorContext

Definition Classes
Actor
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val initPeerMsgHandlerReceiver: PeerMessageReceiver

The place we send messages that we successfully parsed from our peer on the P2P network.
The place we send messages that we successfully parsed from our peer on the P2P network. This is mostly likely a org.bitcoins.node.networking.peer.PeerMessageSender
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def logger(implicit config: NodeAppConfig): MarkedLogger

Attributes
protected
Definition Classes
P2PLogger
def manager: ActorRef

The manager is an actor that handles the underlying low level I/O resources (selectors, channels) and instantiates workers for specific tasks, such as listening to incoming connections.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val network: NetworkParameters

The parameters for the network we are connected to
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val peer: Peer
def postRestart(reason: Throwable): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def postStop(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preRestart(reason: Throwable, message: Option[Any]): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preStart(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def receive: Receive

This context is responsible for initializing a tcp connection with a peer on the bitcoin p2p network
This context is responsible for initializing a tcp connection with a peer on the bitcoin p2p network

Definition Classes
P2PClientActor → Actor
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
def supervisorStrategy: SupervisorStrategy

Definition Classes
Actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def unhandled(message: Any): Unit

Definition Classes
Actor
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package networking

case class P2PClientActor(peer: Peer, initPeerMsgHandlerReceiver: PeerMessageReceiver)(implicit config: NodeAppConfig) extends Actor with P2PLogger with Product with Serializable

Instance Constructors

new P2PClientActor(peer: Peer, initPeerMsgHandlerReceiver: PeerMessageReceiver)(implicit config: NodeAppConfig)

Type Members

type Receive = PartialFunction[Any, Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit val context: ActorContext

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val initPeerMsgHandlerReceiver: PeerMessageReceiver

final def isInstanceOf[T0]: Boolean

def logger(implicit config: NodeAppConfig): MarkedLogger

def manager: ActorRef

final def ne(arg0: AnyRef): Boolean

val network: NetworkParameters

final def notify(): Unit

final def notifyAll(): Unit

val peer: Peer

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def receive: Receive

implicit final val self: ActorRef

final def sender(): ActorRef

def supervisorStrategy: SupervisorStrategy

final def synchronized[T0](arg0: ⇒ T0): T0

def unhandled(message: Any): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from P2PLogger

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped