Class ActionListener<TGoal, TFeedback, TResult>

An actionlib action listener.

Emits the following events:

'status' - The status messages received from the action server.
'feedback' - The feedback messages received from the action server.
'result' - The result returned from the action server.

Type Parameters

TGoal
TFeedback
TResult

Hierarchy

EventEmitter<
    {
        feedback: [TFeedback];
        goal: [TGoal];
        result: [TResult];
        status: actionlib_msgs.GoalStatus;
    },
>
- ActionListener

Index

Constructors

constructor

new ActionListener<TGoal, TFeedback, TResult>(
options: { actionName: string; ros: Ros; serverName: string },
): ActionListener<TGoal, TFeedback, TResult>
Type Parameters
- TGoal
- TFeedback
- TResult
Parameters
- options: { actionName: string; ros: Ros; serverName: string }
  - actionName: string
    The action message name, like 'actionlib_tutorials/FibonacciAction'.
  - ros: Ros
    The ROSLIB.Ros connection handle.
  - serverName: string
    The action server name, like '/fibonacci'.
Returns ActionListener<TGoal, TFeedback, TResult>
Overrides EventEmitter<{ status: actionlib_msgs.GoalStatus; feedback: [TFeedback]; result: [TResult]; goal: [TGoal]; }>.constructor
- Defined in src/actionlib/ActionListener.ts:41

Properties

actionName

actionName: string

ros

ros: Ros

serverName

serverName: string

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              goal: [TGoal];
              result: [TResult];
              status: actionlib_msgs.GoalStatus;
          },
      >[Extract<T, "status" | "result" | "feedback" | "goal">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

emit

emit<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
    ...args: ArgumentMap<
        {
            feedback: [TFeedback];
            goal: [TGoal];
            result: [TResult];
            status: actionlib_msgs.GoalStatus;
        },
    >[Extract<T, "status" | "result" | "feedback" | "goal">],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
- ...args: ArgumentMap<
      {
          feedback: [TFeedback];
          goal: [TGoal];
          result: [TResult];
          status: actionlib_msgs.GoalStatus;
      },
  >[Extract<T, "status" | "result" | "feedback" | "goal">]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): ("status" | "result" | "feedback" | "goal")[]
Return an array listing the events for which the emitter has registered listeners.

Returns ("status" | "result" | "feedback" | "goal")[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: "status" | "result" | "feedback" | "goal"): number
Return the number of listeners listening to a given event.
Parameters
- event: "status" | "result" | "feedback" | "goal"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
): (
    (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              goal: [TGoal];
              result: [TResult];
              status: actionlib_msgs.GoalStatus;
          },
      >[Extract<T, "status" | "result" | "feedback" | "goal">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              goal: [TGoal];
              result: [TResult];
              status: actionlib_msgs.GoalStatus;
          },
      >[Extract<T, "status" | "result" | "feedback" | "goal">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              goal: [TGoal];
              result: [TResult];
              status: actionlib_msgs.GoalStatus;
          },
      >[Extract<T, "status" | "result" | "feedback" | "goal">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: "status" | "result" | "feedback" | "goal"): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "status" | "result" | "feedback" | "goal"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends "status" | "result" | "feedback" | "goal">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                goal: [TGoal];
                result: [TResult];
                status: actionlib_msgs.GoalStatus;
            },
        >[Extract<T, "status" | "result" | "feedback" | "goal">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "status" | "result" | "feedback" | "goal"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              goal: [TGoal];
              result: [TResult];
              status: actionlib_msgs.GoalStatus;
          },
      >[Extract<T, "status" | "result" | "feedback" | "goal">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

Class ActionListener<TGoal, TFeedback, TResult>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

actionName: string

ros: Ros

serverName: string

Returns ActionListener<TGoal, TFeedback, TResult>

Properties

actionName

ros

serverName

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns ("status" | "result" | "feedback" | "goal")[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap< { feedback: [TFeedback]; goal: [TGoal]; result: [TResult]; status: actionlib_msgs.GoalStatus; }, >[Extract<T, "status" | "result" | "feedback" | "goal">], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Settings

On This Page

`Static`prefixed

Returns (
(
...args: ArgumentMap<
{
feedback: [TFeedback];
goal: [TGoal];
result: [TResult];
status: actionlib_msgs.GoalStatus;
},
>[Extract<T, "status" | "result" | "feedback" | "goal">],
) => void
)[]