MessageStream (org.codehaus.gpars)

groovyx.gpars.actor.impl.MessageStream

Represents a stream of messages and forms the base class for actors
Authors:
Alex Tkachman, Vaclav Pech, Dierk Koenig

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`MessageStream.RemoteMessageStream`
`private static class`	`MessageStream.ResultWaiter`	Represents a pending request for a reply from an actor.
`static class`	`MessageStream.SendTo`

Field Summary

Fields
Modifiers	Name	Description
`private static long`	`serialVersionUID`

Inherited fields
Fields inherited from class	Fields
`class WithSerialId`	`serialHandle, serialVersionUID`

Constructor Summary

Constructors
Constructor and description
`MessageStream ()`

Methods Summary

Methods
Type	Name and description
`MessageStream`	`call(T message)` Same as send
`java.lang.Class<RemoteMessageStream>`	`getRemoteClass()`
`MessageStream`	`leftShift(T message)` Same as send
`static void`	`reInterrupt()`
`MessageStream`	`send(java.lang.Object message)` Send message to stream and return immediately
`MessageStream`	`send()` Convenience method for send(new Object()).
`MessageStream`	`send(T message, MessageStream replyTo)` Send message to stream and return immediately.
`V`	`sendAndWait(T message)` Sends a message and waits for a reply.
`java.lang.Object`	`sendAndWait(T message, long timeout, java.util.concurrent.TimeUnit units)` Sends a message and waits for a reply.
`java.lang.Object`	`sendAndWait(T message, groovy.time.Duration duration)` Sends a message and waits for a reply.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class WithSerialId`	`createRemoteHandle, getOrCreateSerialHandle, getRemoteClass, writeReplace`
`class java.lang.Object`	`java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private static final long serialVersionUID
- Constructor Detail
  - MessageStream()
- Method Detail
  - public final MessageStream call(T message)
    
    Same as send
    Returns:
    original stream
    Parameters:
    message - to send
  - @java.lang.Override @java.lang.SuppressWarnings("unchecked") public java.lang.Class<RemoteMessageStream> getRemoteClass()
  - public final MessageStream leftShift(T message)
    
    Same as send
    Returns:
    original stream
    Parameters:
    message - to send
  - static void reInterrupt()
  - public MessageStream send(java.lang.Object message)
    
    Send message to stream and return immediately
    Returns:
    always return message stream itself
    Parameters:
    message - message to send
  - public final MessageStream send()
    
    Convenience method for send(new Object()).
    Returns:
    always return message stream itself
  - public final MessageStream send(T message, MessageStream replyTo)
    
    Send message to stream and return immediately. Allows to specify an arbitrary actor to send replies to. By default replies are sent to the originator (sender) of each message, however, when a different actor is specified as the optional second argument to the send() method, this supplied actor will receive the replies instead.
    Returns:
    always return message stream itself
    Parameters:
    message - message to send
    replyTo - where to send reply
    - type of message accepted by the stream
  - public final V sendAndWait(T message)
    
    Sends a message and waits for a reply. Returns the reply or throws an IllegalStateException, if the target actor cannot reply.
    throws:
    InterruptedException if interrupted while waiting
    
    Returns:
    The message that came in reply to the original send.
    Parameters:
    message - message to send
  - public final java.lang.Object sendAndWait(T message, long timeout, java.util.concurrent.TimeUnit units)
    
    Sends a message and waits for a reply. Timeouts after the specified timeout. In case of timeout returns null. Returns the reply or throws an IllegalStateException, if the target actor cannot reply.
    throws:
    InterruptedException if interrupted while waiting
    
    Returns:
    The message that came in reply to the original send.
    Parameters:
    message - message to send
    timeout - timeout
    units - units
  - public final java.lang.Object sendAndWait(T message, groovy.time.Duration duration)
    
    Sends a message and waits for a reply. Timeouts after the specified timeout. In case of timeout returns null. Returns the reply or throws an IllegalStateException, if the target actor cannot reply.
    throws:
    InterruptedException if interrupted while waiting
    
    Returns:
    The message that came in reply to the original send.
    Parameters:
    message - message to send
    duration - timeout

| Detail:
Field
Constructor
Method

[Java] Class MessageStream

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final long serialVersionUID

Constructor Detail

MessageStream()

Method Detail

public final MessageStream call(T message)

@java.lang.Override @java.lang.SuppressWarnings("unchecked") public java.lang.Class<RemoteMessageStream> getRemoteClass()

public final MessageStream leftShift(T message)

static void reInterrupt()

public MessageStream send(java.lang.Object message)

public final MessageStream send()

public final MessageStream send(T message, MessageStream replyTo)

public final V sendAndWait(T message)

public final java.lang.Object sendAndWait(T message, long timeout, java.util.concurrent.TimeUnit units)

public final java.lang.Object sendAndWait(T message, groovy.time.Duration duration)