net.corda.core.messaging

Package net.corda.core.messaging

Types

AllPossibleRecipients	`interface AllPossibleRecipients : MessageRecipients` A special base class for the set of all possible recipients, without having to identify who they all are.
ClientRpcSslOptions	`data class ClientRpcSslOptions` As an RPC Client, use this class to point to the truststore that contains the RPC SSL certificate provided by the node admin
CordaRPCOps	`interface CordaRPCOps : RPCOps` RPC operations that the node exposes to clients.
DataFeed	`data class DataFeed<out A, B>` The Data feed contains a snapshot of the requested data and an Observable of future updates.
FlowHandle	`interface FlowHandle<A> : AutoCloseable` FlowHandle is a serialisable handle for the started flow, parameterised by the type of the flow's return value.
FlowHandleImpl	`data class FlowHandleImpl<A> : FlowHandle<A>`
FlowHandleWithClientId	`interface FlowHandleWithClientId<A> : FlowHandle<A>`
FlowHandleWithClientIdImpl	`data class FlowHandleWithClientIdImpl<A> : FlowHandleWithClientId<A>`
FlowProgressHandle	`interface FlowProgressHandle<A> : FlowHandle<A>` FlowProgressHandle is a serialisable handle for the started flow, parameterised by the type of the flow's return value.
FlowProgressHandleImpl	`data class FlowProgressHandleImpl<A> : FlowProgressHandle<A>`
MessageRecipientGroup	`interface MessageRecipientGroup : MessageRecipients` A base class for a set of recipients specifically identified by the sender.
MessageRecipients	`interface MessageRecipients` The interface for a group of message recipients (which may contain only one recipient)
ParametersUpdateInfo	`data class ParametersUpdateInfo` Data class containing information about the scheduled network parameters update. The info is emitted every time node receives network map with ParametersUpdate which wasn't seen before. For more information see: CordaRPCOps.networkParametersFeed and CordaRPCOps.acceptNewNetworkParameters.
RPCOps	`interface RPCOps` Base interface that all RPC servers must implement. Note: in Corda there's only one RPC interface. This base interface is here in case we split the RPC system out into a separate library one day.
SingleMessageRecipient	`interface SingleMessageRecipient : MessageRecipients` A base class for the case of point-to-point messages
StateMachineInfo	`data class StateMachineInfo` Represents information about a flow (the name "state machine" is legacy, Kotlin users can use the FlowInfo type alias). You can access progress tracking, information about why the flow was started and so on.
StateMachineTransactionMapping	`data class StateMachineTransactionMapping`
StateMachineUpdate	`sealed class StateMachineUpdate`

Annotations

RPCReturnsObservables

annotation class RPCReturnsObservables

If an RPC is tagged with this annotation it may return one or more observables anywhere in its response graph. Calling such a method comes with consequences: it's slower, and consumes server side resources as observations will buffer up on the server until they're consumed by the client.

Type Aliases

FlowInfo

typealias FlowInfo = StateMachineInfo

An alias for StateMachineInfo which uses more modern terminology.

Functions

pendingFlowsCount	`fun CordaRPCOps.pendingFlowsCount(): DataFeed<Int, <ERROR CLASS><Int, Int>>` Returns a DataFeed of the number of pending flows. The Observable for the updates will complete the moment all pending flows will have terminated.
startFlow	`fun <T, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: () -> R): FlowHandle<T>` `fun <T, A, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: (A) -> R, arg0: A): FlowHandle<T>` `fun <T, A, B, C, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: (A, B, C) -> R, arg0: A, arg1: B, arg2: C): FlowHandle<T>` `fun <T, A, B, C, D, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: (A, B, C, D) -> R, arg0: A, arg1: B, arg2: C, arg3: D): FlowHandle<T>` `fun <T, A, B, C, D, E, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: (A, B, C, D, E) -> R, arg0: A, arg1: B, arg2: C, arg3: D, arg4: E): FlowHandle<T>` `fun <T, A, B, C, D, E, F, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: (A, B, C, D, E, F) -> R, arg0: A, arg1: B, arg2: C, arg3: D, arg4: E, arg5: F): FlowHandle<T>fun <T, A, B, R : FlowLogic<T>> CordaRPCOps.startFlow(flowConstructor: (A, B) -> R, arg0: A, arg1: B): FlowHandle<T>` Extension function for type safe invocation of flows from Kotlin, for example:
startFlowWithClientId	`fun <T, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: () -> R): FlowHandleWithClientId<T>` Extension function for type safe invocation of flows from Kotlin, with clientId. `fun <T, A, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: (A) -> R, arg0: A): FlowHandleWithClientId<T>` `fun <T, A, B, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: (A, B) -> R, arg0: A, arg1: B): FlowHandleWithClientId<T>` `fun <T, A, B, C, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: (A, B, C) -> R, arg0: A, arg1: B, arg2: C): FlowHandleWithClientId<T>` `fun <T, A, B, C, D, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: (A, B, C, D) -> R, arg0: A, arg1: B, arg2: C, arg3: D): FlowHandleWithClientId<T>` `fun <T, A, B, C, D, E, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: (A, B, C, D, E) -> R, arg0: A, arg1: B, arg2: C, arg3: D, arg4: E): FlowHandleWithClientId<T>` `fun <T, A, B, C, D, E, F, R : FlowLogic<T>> CordaRPCOps.startFlowWithClientId(clientId: String, flowConstructor: (A, B, C, D, E, F) -> R, arg0: A, arg1: B, arg2: C, arg3: D, arg4: E, arg5: F): FlowHandleWithClientId<T>`
startTrackedFlow	`fun <T, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: () -> R): FlowProgressHandle<T>` Extension function for type safe invocation of flows from Kotlin, with progress tracking enabled. `fun <T, A, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: (A) -> R, arg0: A): FlowProgressHandle<T>` `fun <T, A, B, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: (A, B) -> R, arg0: A, arg1: B): FlowProgressHandle<T>` `fun <T, A, B, C, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: (A, B, C) -> R, arg0: A, arg1: B, arg2: C): FlowProgressHandle<T>` `fun <T, A, B, C, D, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: (A, B, C, D) -> R, arg0: A, arg1: B, arg2: C, arg3: D): FlowProgressHandle<T>` `fun <T, A, B, C, D, E, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: (A, B, C, D, E) -> R, arg0: A, arg1: B, arg2: C, arg3: D, arg4: E): FlowProgressHandle<T>` `fun <T, A, B, C, D, E, F, R : FlowLogic<T>> CordaRPCOps.startTrackedFlow(flowConstructor: (A, B, C, D, E, F) -> R, arg0: A, arg1: B, arg2: C, arg3: D, arg4: E, arg5: F): FlowProgressHandle<T>`
vaultQueryBy	`fun <T : ContractState> CordaRPCOps.vaultQueryBy(criteria: QueryCriteria = QueryCriteria.VaultQueryCriteria(), paging: PageSpecification = PageSpecification(), sorting: Sort = Sort(emptySet())): Page<T>`
vaultTrackBy	`fun <T : ContractState> CordaRPCOps.vaultTrackBy(criteria: QueryCriteria = QueryCriteria.VaultQueryCriteria(), paging: PageSpecification = PageSpecification(), sorting: Sort = Sort(emptySet())): DataFeed<Page<T>, Update<T>>`