docs/net.corda.testing.node.internal/InternalMockNetwork

InternalMockNetwork

open class InternalMockNetwork(cordappPackages: List<String> = emptyList(), defaultParameters: MockNetworkParameters = MockNetworkParameters(), val networkSendManuallyPumped: Boolean = defaultParameters.networkSendManuallyPumped, val threadPerNode: Boolean = defaultParameters.threadPerNode, servicePeerAllocationStrategy: InMemoryMessagingNetwork.ServicePeerAllocationStrategy = defaultParameters.servicePeerAllocationStrategy, val notarySpecs: List<MockNetworkNotarySpec> = defaultParameters.notarySpecs, val testDirectory: Path = Paths.get("build") / "mock-network" / getTimestampAsDirectoryName(), val initialNetworkParameters: <Error class: unknown class> = testNetworkParameters(), val defaultFactory: (MockNodeArgs) -> InternalMockNetwork.MockNode = { args -> MockNode(args) }, cordappsForAllNodes: Collection<TestCordappInternal> = emptySet(), val autoVisibleNodes: Boolean = true) : AutoCloseable

Constructors

InternalMockNetwork

constructor(cordappPackages: List<String> = emptyList(), defaultParameters: MockNetworkParameters = MockNetworkParameters(), networkSendManuallyPumped: Boolean = defaultParameters.networkSendManuallyPumped, threadPerNode: Boolean = defaultParameters.threadPerNode, servicePeerAllocationStrategy: InMemoryMessagingNetwork.ServicePeerAllocationStrategy = defaultParameters.servicePeerAllocationStrategy, notarySpecs: List<MockNetworkNotarySpec> = defaultParameters.notarySpecs, testDirectory: Path = Paths.get("build") / "mock-network" / getTimestampAsDirectoryName(), initialNetworkParameters: <Error class: unknown class> = testNetworkParameters(), defaultFactory: (MockNodeArgs) -> InternalMockNetwork.MockNode = { args -> MockNode(args) }, cordappsForAllNodes: Collection<TestCordappInternal> = emptySet(), autoVisibleNodes: Boolean = true)

Types

Companion

object Companion

MockNode

open class MockNode(args: MockNodeArgs, mockFlowManager: MockNodeFlowManager = args.flowManager, allowAppSchemaUpgradeWithCheckpoints: Boolean = false)

Properties

autoVisibleNodes

val autoVisibleNodes: Boolean = true

defaultFactory

val defaultFactory: (MockNodeArgs) -> InternalMockNetwork.MockNode

defaultNotaryIdentity

val defaultNotaryIdentity: <Error class: unknown class>

Return the identity of the default notary node.

defaultNotaryNode

val defaultNotaryNode: TestStartedNode

Returns the single notary node on the network. Throws if there are none or more than one.

initialNetworkParameters

val initialNetworkParameters: <Error class: unknown class>

messagingNetwork

val messagingNetwork: InMemoryMessagingNetwork

networkId

val networkId: <Error class: unknown class>

networkParameters

var networkParameters: <Error class: unknown class>

networkSendManuallyPumped

val networkSendManuallyPumped: Boolean

nextNodeId

var nextNodeId: Int

nodes

val nodes: List<InternalMockNetwork.MockNode>

A read only view of the current set of nodes.

notaryNodes

val notaryNodes: List<TestStartedNode>

Returns the list of nodes started by the network. Each notary specified when the network is constructed (notarySpecs parameter) maps 1:1 to the notaries returned by this list.

notarySpecs

val notarySpecs: List<MockNetworkNotarySpec>

testDirectory

val testDirectory: Path

threadPerNode

val threadPerNode: Boolean

Functions

addressToNode

fun addressToNode(msgRecipient: <Error class: unknown class>): InternalMockNetwork.MockNode

baseDirectory

fun baseDirectory(nodeId: Int): Path

fun baseDirectory(node: TestStartedNode): Path

open override fun close()

createNode

fun createNode(parameters: InternalMockNodeParameters = InternalMockNodeParameters()): TestStartedNode

fun createNode(parameters: InternalMockNodeParameters = InternalMockNodeParameters(), nodeFactory: (MockNodeArgs) -> InternalMockNetwork.MockNode): TestStartedNode

Like the other createNode but takes a nodeFactory and propagates its MockNode subtype.

createPartyNode

fun createPartyNode(legalName: <Error class: unknown class>? = null): TestStartedNode

createUnstartedNode

fun createUnstartedNode(parameters: InternalMockNodeParameters = InternalMockNodeParameters(), nodeFactory: (MockNodeArgs) -> InternalMockNetwork.MockNode = defaultFactory): InternalMockNetwork.MockNode

restartNode

fun restartNode(node: TestStartedNode, parameters: InternalMockNodeParameters = InternalMockNodeParameters(), nodeFactory: (MockNodeArgs) -> InternalMockNetwork.MockNode = defaultFactory, resetDb: () -> Unit = {}): TestStartedNode

runNetwork

fun runNetwork(rounds: Int = -1)

Asks every node in order to process any queued up inbound messages. This may in turn result in nodes sending more messages to each other, thus, a typical usage is to call runNetwork with the rounds parameter set to -1 (the default) which simply runs as many rounds as necessary to result in network stability (no nodes sent any messages in the last round).

startNodes

fun startNodes()

stopNode

fun stopNode(nodeId: Int)

stopNodes

fun stopNodes()

waitQuiescent

fun waitQuiescent()

Block until all scheduled activity, active flows and network activity has ceased.