RxResultSubscriber (rxjava2 2.0.0 API)

org.grails.plugins.rx.web.RxResultSubscriber

All Implemented Interfaces and Traits:

javax.servlet.AsyncListener, io.reactivex.Observer
```
@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class RxResultSubscriber
extends java.lang.Object
```
A io.reactivex.Emitter that processed items emitted from an java.util.Observable and produces an appropriate response.

If the java.util.Observable emits a RxResult then processing is delegated to the result with the execute method being wrapped in the asynchronous request.

Otherwise the current controller's respond method is called with the object emitted from the observable

Authors:
Graeme Rocher
Since:
6.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DATA_PREFIX`	The prefix for server sent events
`protected RxCompletionStrategy`	`completionStrategy`

Properties Summary

Properties
Type	Name and description
`boolean`	`asyncComplete`
`org.grails.plugins.web.async.GrailsAsyncContext`	`asyncContext` The Async context
`grails.artefact.Controller`	`controller` The controller instance
`grails.core.GrailsControllerClass`	`controllerClass` The controller class
`io.reactivex.disposables.Disposable`	`disposable` the disposable
`org.grails.web.errors.GrailsExceptionResolver`	`exceptionResolver` The exception handler
`boolean`	`isRender` Whether this is a call to render
`grails.web.mapping.LinkGenerator`	`linkGenerator` The link generator
`java.lang.String`	`serverSendEventName` The server send event name
`boolean`	`serverSendEvents` Whether server end events are being used
`grails.web.UrlConverter`	`urlConverter` The url converter

Constructor Summary

Constructors
Constructor and description
`RxResultSubscriber (org.grails.plugins.web.async.GrailsAsyncContext asyncContext, org.grails.web.errors.GrailsExceptionResolver exceptionResolver, grails.web.mapping.LinkGenerator linkGenerator, grails.core.GrailsControllerClass controllerClass, grails.artefact.Controller controller)`

Methods Summary

Methods
Type	Name and description
`void`	`onComplete()`
`void`	`onComplete(javax.servlet.AsyncEvent event)`
`void`	`onError(java.lang.Throwable e)`
`void`	`onError(javax.servlet.AsyncEvent event)`
`void`	`onNext(java.lang.Object o)`
`void`	`onStartAsync(javax.servlet.AsyncEvent event)`
`void`	`onSubscribe(io.reactivex.disposables.Disposable d)`
`void`	`onTimeout(javax.servlet.AsyncEvent event)`
`protected void`	`sendDefaultError(java.lang.Throwable e, javax.servlet.http.HttpServletResponse httpServletResponse)`
`T`	`withRequest(groovy.lang.Closure<T> callable)` Wrap the given closure in asynchronous request processing

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), 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
  - public static final java.lang.String DATA_PREFIX
    
    The prefix for server sent events
  - protected RxCompletionStrategy completionStrategy
- Property Detail
  - boolean asyncComplete
  - final org.grails.plugins.web.async.GrailsAsyncContext asyncContext
    
    The Async context
  - final grails.artefact.Controller controller
    
    The controller instance
  - final grails.core.GrailsControllerClass controllerClass
    
    The controller class
  - io.reactivex.disposables.Disposable disposable
    
    the disposable
  - final org.grails.web.errors.GrailsExceptionResolver exceptionResolver
    
    The exception handler
  - boolean isRender
    
    Whether this is a call to render
  - final grails.web.mapping.LinkGenerator linkGenerator
    
    The link generator
  - java.lang.String serverSendEventName
    
    The server send event name
  - boolean serverSendEvents
    
    Whether server end events are being used
  - grails.web.UrlConverter urlConverter
    
    The url converter
- Constructor Detail
  - RxResultSubscriber(org.grails.plugins.web.async.GrailsAsyncContext asyncContext, org.grails.web.errors.GrailsExceptionResolver exceptionResolver, grails.web.mapping.LinkGenerator linkGenerator, grails.core.GrailsControllerClass controllerClass, grails.artefact.Controller controller)
- Method Detail
  - @java.lang.Override void onComplete()
  - @java.lang.Override void onComplete(javax.servlet.AsyncEvent event)
  - @java.lang.Override void onError(java.lang.Throwable e)
  - @java.lang.Override void onError(javax.servlet.AsyncEvent event)
  - @java.lang.Override void onNext(java.lang.Object o)
  - @java.lang.Override void onStartAsync(javax.servlet.AsyncEvent event)
  - @java.lang.Override void onSubscribe(io.reactivex.disposables.Disposable d)
  - @java.lang.Override void onTimeout(javax.servlet.AsyncEvent event)
  - protected void sendDefaultError(java.lang.Throwable e, javax.servlet.http.HttpServletResponse httpServletResponse)
  - T withRequest(groovy.lang.Closure<T> callable)
    
    Wrap the given closure in asynchronous request processing
    Parameters:
    callable - The closure
    Returns:
    The return result of the closure

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class RxResultSubscriber

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DATA_PREFIX

protected RxCompletionStrategy completionStrategy

Property Detail

boolean asyncComplete

final org.grails.plugins.web.async.GrailsAsyncContext asyncContext

final grails.artefact.Controller controller

final grails.core.GrailsControllerClass controllerClass

io.reactivex.disposables.Disposable disposable

final org.grails.web.errors.GrailsExceptionResolver exceptionResolver

boolean isRender

final grails.web.mapping.LinkGenerator linkGenerator

java.lang.String serverSendEventName

boolean serverSendEvents

grails.web.UrlConverter urlConverter

Constructor Detail

RxResultSubscriber(org.grails.plugins.web.async.GrailsAsyncContext asyncContext, org.grails.web.errors.GrailsExceptionResolver exceptionResolver, grails.web.mapping.LinkGenerator linkGenerator, grails.core.GrailsControllerClass controllerClass, grails.artefact.Controller controller)

Method Detail

@java.lang.Override void onComplete()

@java.lang.Override void onComplete(javax.servlet.AsyncEvent event)

@java.lang.Override void onError(java.lang.Throwable e)

@java.lang.Override void onError(javax.servlet.AsyncEvent event)

@java.lang.Override void onNext(java.lang.Object o)

@java.lang.Override void onStartAsync(javax.servlet.AsyncEvent event)

@java.lang.Override void onSubscribe(io.reactivex.disposables.Disposable d)

@java.lang.Override void onTimeout(javax.servlet.AsyncEvent event)

protected void sendDefaultError(java.lang.Throwable e, javax.servlet.http.HttpServletResponse httpServletResponse)

T withRequest(groovy.lang.Closure<T> callable)