org.apache.tinkerpop.gremlin.process.computer

## Interface Messenger<M>

- All Known Implementing Classes:
    GiraphMessenger, SingleMessenger, SparkMessenger, TinkerMessenger

      public interface Messenger<M>

  The `Messenger` serves as the routing system for messages between vertices. For distributed systems, the messenger can implement a "message passing" engine (distributed memory). For single machine systems, the messenger can implement a "state sharing" engine (shared memory). Each messenger is tied to the particular vertex distributing the message.
  Author:
    Marko A. Rodriguez (http://markorodriguez.com), Matthias Broecheler (me@matthiasb.com)

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<M>` | `receiveMessages()` Receive all incoming messages to the currently executing vertex.
    `void` | `sendMessage(MessageScope messageScope, M message)` The currently executing vertex can send a message with provided `MessageScope`.

- - ### Method Detail

    - #### receiveMessages

          Iterator<M> receiveMessages()

      Receive all incoming messages to the currently executing vertex.
      Returns:
        the messages for the vertex

    - #### sendMessage

          void sendMessage(MessageScope messageScope,
                           M message)

      The currently executing vertex can send a message with provided `MessageScope`.
      Parameters:
        `messageScope` - the message scope of the message being sent
        `message` - the message to send

Copyright © 2013–2020 Apache Software Foundation. All rights reserved.