Skip to content

Commit 6014fad

Browse files
committed
Add docs for createActionServer
Signed-off-by: Jacob Perron <[email protected]>
1 parent b4b7922 commit 6014fad

File tree

1 file changed

+12
-0
lines changed
  • rcljava/src/main/java/org/ros2/rcljava/node

1 file changed

+12
-0
lines changed

rcljava/src/main/java/org/ros2/rcljava/node/Node.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,18 @@ <T extends ServiceDefinition> Client<T> createClient(
144144
<T extends ServiceDefinition> Client<T> createClient(final Class<T> serviceType,
145145
final String serviceName) throws NoSuchFieldException, IllegalAccessException;
146146

147+
/**
148+
* Create an ActionServer&lt;T&gt;.
149+
*
150+
* @param <T> The type of action that will be handled by the created @{link ActionServer}.
151+
* @param actionName The name of action that the create @{link ActionServer} will offer.
152+
* @param goalCallback The callback that will be called when the @{link ActionServer}
153+
* receives a new goal request.
154+
* @param cancelCallback The callback that will be called when the @{link ActionServer}
155+
* receives a cancle request for an active goal.
156+
* @param acceptedCallback The callback that will be called when the @{link ActionServer}
157+
* accepts a goal request.
158+
*/
147159
<T extends ActionDefinition> ActionServer<T> createActionServer(final Class<T> actionType,
148160
final String actionName,
149161
final GoalCallback<? extends GoalRequestDefinition<T>> goalCallback,

0 commit comments

Comments
 (0)