mirror of https://github.com/dapr/java-sdk.git
402 lines
35 KiB
HTML
402 lines
35 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (16) on Thu Oct 13 17:23:51 PDT 2022 -->
|
|
<title>ActorRuntime (dapr-sdk-parent 1.7.0 API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2022-10-13">
|
|
<meta name="description" content="declaration: package: io.dapr.actors.runtime, class: ActorRuntime">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar.top">
|
|
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/ActorRuntime.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip.navbar.top">
|
|
<!-- -->
|
|
</span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">io.dapr.actors.runtime</a></div>
|
|
<h1 title="Class ActorRuntime" class="title">Class ActorRuntime</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">io.dapr.actors.runtime.ActorRuntime</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ActorRuntime</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
|
implements <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></span></div>
|
|
<div class="block">Contains methods to register actor types. Registering the types allows the
|
|
runtime to create instances of the actor.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method.summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#close()">close</a></span>()</code></div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#deactivate(java.lang.String,java.lang.String)">deactivate</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Deactivates an actor for an actor type with given actor id.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getConfig()">getConfig</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Gets the Actor configuration for this runtime.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="ActorRuntime.html" title="class in io.dapr.actors.runtime">ActorRuntime</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getInstance()">getInstance</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Returns an ActorRuntime object.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>reactor.core.publisher.Mono<byte[]></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#invoke(java.lang.String,java.lang.String,java.lang.String,byte%5B%5D)">invoke</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorMethodName,
|
|
byte[] payload)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Invokes the specified method for the actor, this is mainly used for cross
|
|
language invocation.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#invokeReminder(java.lang.String,java.lang.String,java.lang.String,byte%5B%5D)">invokeReminder</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> reminderName,
|
|
byte[] params)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Fires a reminder for the Actor.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#invokeTimer(java.lang.String,java.lang.String,java.lang.String,byte%5B%5D)">invokeTimer</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> timerName,
|
|
byte[] params)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Fires a timer for the Actor.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>><br>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#registerActor(java.lang.Class)">registerActor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Registers an actor with the runtime, using <a href="../../serializer/DefaultObjectSerializer.html" title="class in io.dapr.serializer"><code>DefaultObjectSerializer</code></a> and <code>DefaultActorFactory</code>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>><br>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#registerActor(java.lang.Class,io.dapr.actors.runtime.ActorFactory)">registerActor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz,
|
|
<a href="ActorFactory.html" title="interface in io.dapr.actors.runtime">ActorFactory</a><T> actorFactory)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Registers an actor with the runtime, using <a href="../../serializer/DefaultObjectSerializer.html" title="class in io.dapr.serializer"><code>DefaultObjectSerializer</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>><br>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#registerActor(java.lang.Class,io.dapr.actors.runtime.ActorFactory,io.dapr.serializer.DaprObjectSerializer,io.dapr.serializer.DaprObjectSerializer)">registerActor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz,
|
|
<a href="ActorFactory.html" title="interface in io.dapr.actors.runtime">ActorFactory</a><T> actorFactory,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> objectSerializer,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> stateSerializer)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Registers an actor with the runtime.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>><br>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#registerActor(java.lang.Class,io.dapr.serializer.DaprObjectSerializer,io.dapr.serializer.DaprObjectSerializer)">registerActor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> objectSerializer,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> stateSerializer)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Registers an actor with the runtime.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>byte[]</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#serializeConfig()">serializeConfig</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Gets the Actor configuration for this runtime.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method.detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="getInstance()">
|
|
<h3>getInstance</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ActorRuntime.html" title="class in io.dapr.actors.runtime">ActorRuntime</a></span> <span class="element-name">getInstance</span>()</div>
|
|
<div class="block">Returns an ActorRuntime object.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>An ActorRuntime object.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConfig()">
|
|
<h3>getConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ActorRuntimeConfig.html" title="class in io.dapr.actors.runtime">ActorRuntimeConfig</a></span> <span class="element-name">getConfig</span>()</div>
|
|
<div class="block">Gets the Actor configuration for this runtime.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Actor configuration.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="serializeConfig()">
|
|
<h3>serializeConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">serializeConfig</span>()
|
|
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
|
|
<div class="block">Gets the Actor configuration for this runtime.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Actor configuration serialized.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If cannot serialize config.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerActor(java.lang.Class)">
|
|
<h3>registerActor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>></span> <span class="return-type">void</span> <span class="element-name">registerActor</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz)</span></div>
|
|
<div class="block">Registers an actor with the runtime, using <a href="../../serializer/DefaultObjectSerializer.html" title="class in io.dapr.serializer"><code>DefaultObjectSerializer</code></a> and <code>DefaultActorFactory</code>.
|
|
|
|
<a href="../../serializer/DefaultObjectSerializer.html" title="class in io.dapr.serializer"><code>DefaultObjectSerializer</code></a> is not recommended for production scenarios.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Actor class type.</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>clazz</code> - The type of actor.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerActor(java.lang.Class,io.dapr.actors.runtime.ActorFactory)">
|
|
<h3>registerActor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>></span> <span class="return-type">void</span> <span class="element-name">registerActor</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz,
|
|
<a href="ActorFactory.html" title="interface in io.dapr.actors.runtime">ActorFactory</a><T> actorFactory)</span></div>
|
|
<div class="block">Registers an actor with the runtime, using <a href="../../serializer/DefaultObjectSerializer.html" title="class in io.dapr.serializer"><code>DefaultObjectSerializer</code></a>.
|
|
|
|
<a href="../../serializer/DefaultObjectSerializer.html" title="class in io.dapr.serializer"><code>DefaultObjectSerializer</code></a> is not recommended for production scenarios.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Actor class type.</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>clazz</code> - The type of actor.</dd>
|
|
<dd><code>actorFactory</code> - An optional factory to create actors. This can be used for dependency injection.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerActor(java.lang.Class,io.dapr.serializer.DaprObjectSerializer,io.dapr.serializer.DaprObjectSerializer)">
|
|
<h3>registerActor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>></span> <span class="return-type">void</span> <span class="element-name">registerActor</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> objectSerializer,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> stateSerializer)</span></div>
|
|
<div class="block">Registers an actor with the runtime.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Actor class type.</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>clazz</code> - The type of actor.</dd>
|
|
<dd><code>objectSerializer</code> - Serializer for Actor's request and response objects.</dd>
|
|
<dd><code>stateSerializer</code> - Serializer for Actor's state objects.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerActor(java.lang.Class,io.dapr.actors.runtime.ActorFactory,io.dapr.serializer.DaprObjectSerializer,io.dapr.serializer.DaprObjectSerializer)">
|
|
<h3>registerActor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="AbstractActor.html" title="class in io.dapr.actors.runtime">AbstractActor</a>></span> <span class="return-type">void</span> <span class="element-name">registerActor</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz,
|
|
<a href="ActorFactory.html" title="interface in io.dapr.actors.runtime">ActorFactory</a><T> actorFactory,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> objectSerializer,
|
|
<a href="../../serializer/DaprObjectSerializer.html" title="interface in io.dapr.serializer">DaprObjectSerializer</a> stateSerializer)</span></div>
|
|
<div class="block">Registers an actor with the runtime.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Actor class type.</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>clazz</code> - The type of actor.</dd>
|
|
<dd><code>actorFactory</code> - An optional factory to create actors. This can be used for dependency injection.</dd>
|
|
<dd><code>objectSerializer</code> - Serializer for Actor's request and response objects.</dd>
|
|
<dd><code>stateSerializer</code> - Serializer for Actor's state objects.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="deactivate(java.lang.String,java.lang.String)">
|
|
<h3>deactivate</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">deactivate</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId)</span></div>
|
|
<div class="block">Deactivates an actor for an actor type with given actor id.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>actorTypeName</code> - Actor type name to deactivate the actor for.</dd>
|
|
<dd><code>actorId</code> - Actor id for the actor to be deactivated.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Async void task.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="invoke(java.lang.String,java.lang.String,java.lang.String,byte[])">
|
|
<h3>invoke</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<byte[]></span> <span class="element-name">invoke</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorMethodName,
|
|
byte[] payload)</span></div>
|
|
<div class="block">Invokes the specified method for the actor, this is mainly used for cross
|
|
language invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>actorTypeName</code> - Actor type name to invoke the method for.</dd>
|
|
<dd><code>actorId</code> - Actor id for the actor for which method will be invoked.</dd>
|
|
<dd><code>actorMethodName</code> - Method name on actor type which will be invoked.</dd>
|
|
<dd><code>payload</code> - RAW payload for the actor method.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Response for the actor method.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="invokeReminder(java.lang.String,java.lang.String,java.lang.String,byte[])">
|
|
<h3>invokeReminder</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">invokeReminder</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> reminderName,
|
|
byte[] params)</span></div>
|
|
<div class="block">Fires a reminder for the Actor.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>actorTypeName</code> - Actor type name to invoke the method for.</dd>
|
|
<dd><code>actorId</code> - Actor id for the actor for which method will be invoked.</dd>
|
|
<dd><code>reminderName</code> - The name of reminder provided during registration.</dd>
|
|
<dd><code>params</code> - Params for the reminder.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Async void task.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="invokeTimer(java.lang.String,java.lang.String,java.lang.String,byte[])">
|
|
<h3>invokeTimer</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">invokeTimer</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorTypeName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> actorId,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> timerName,
|
|
byte[] params)</span></div>
|
|
<div class="block">Fires a timer for the Actor.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>actorTypeName</code> - Actor type name to invoke the method for.</dd>
|
|
<dd><code>actorId</code> - Actor id for the actor for which method will be invoked.</dd>
|
|
<dd><code>timerName</code> - The name of timer provided during registration.</dd>
|
|
<dd><code>params</code> - Params to trigger timer.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Async void task.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="close()">
|
|
<h3>close</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 2022. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|