Package akka.remote.artery.tcp

Class TcpFraming

java.lang.Object

akka.stream.stage.GraphStageWithMaterializedValue<S,NotUsed>

akka.stream.stage.GraphStage<FlowShape<ByteString,T>>

akka.stream.impl.io.ByteStringParser<EnvelopeBuffer>

akka.remote.artery.tcp.TcpFraming

All Implemented Interfaces:

Graph<FlowShape<ByteString,EnvelopeBuffer>,NotUsed>

public class TcpFraming
extends ByteStringParser<EnvelopeBuffer>

Nested Class Summary

Nested classes/interfaces inherited from class akka.stream.impl.io.ByteStringParser

ByteStringParser.ByteReader, ByteStringParser.FinishedParser$, ByteStringParser.ParseResult<T>, ByteStringParser.ParseResult$, ByteStringParser.ParseStep<T>, ByteStringParser.ParsingException, ByteStringParser.ParsingLogic

Nested classes/interfaces inherited from interface akka.stream.Graph

Graph.GraphMapMatVal<S extends Shape,M>

Constructor Summary

Constructors

Constructor	Description
TcpFraming(RemotingFlightRecorder flightRecorder)

Method Summary

Modifier and Type	Method	Description
static RemotingFlightRecorder	$lessinit$greater$default$1()	INTERNAL API
GraphStageLogic	createLogic(Attributes inheritedAttributes)
static ByteString	encodeConnectionHeader(int streamId)	When establishing the connection this header is sent first.
static ByteString	encodeFrameHeader(int frameLength)	Each frame starts with the frame header that contains the length of the frame.
static ByteString	Magic()	The first 4 bytes of a new connection must be these 0x64 0x75 0x75 0x64 (AKKA).
static int	Undefined()

Methods inherited from class akka.stream.impl.io.ByteStringParser

CompactionThreshold, initialAttributes, NeedMoreData, shape

Methods inherited from class akka.stream.stage.GraphStage

createLogicAndMaterializedValue

Methods inherited from class akka.stream.stage.GraphStageWithMaterializedValue

createLogicAndMaterializedValue, traversalBuilder, withAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.stream.Graph

addAttributes, async, async, async, named

Constructor Detail

TcpFraming

public TcpFraming(RemotingFlightRecorder flightRecorder)

Method Detail

$lessinit$greater$default$1

public static RemotingFlightRecorder $lessinit$greater$default$1()

INTERNAL API

Undefined

public static int Undefined()

Magic

public static ByteString Magic()

The first 4 bytes of a new connection must be these 0x64 0x75 0x75 0x64 (AKKA). The purpose of the "magic" is to detect and reject weird (accidental) accesses.

encodeConnectionHeader

public static ByteString encodeConnectionHeader(int streamId)

When establishing the connection this header is sent first. It contains a "magic" and the stream identifier for selecting control, ordinary, large inbound streams.

The purpose of the "magic" is to detect and reject weird (accidental) accesses. The magic 4 bytes are 0x64 0x75 0x75 0x64 (AKKA).

The streamId is encoded as 1 byte.

encodeFrameHeader

public static ByteString encodeFrameHeader(int frameLength)

Each frame starts with the frame header that contains the length of the frame. The frameLength is encoded as 4 bytes (little endian).

createLogic

public GraphStageLogic createLogic(Attributes inheritedAttributes)

Specified by:

createLogic in class GraphStage<FlowShape<ByteString,EnvelopeBuffer>>