ServerSentEvent (RxJava Javadoc 0.5.0)

java.lang.Object
- io.reactivex.netty.protocol.http.sse.ServerSentEvent

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted
```
public class ServerSentEvent
extends java.lang.Object
implements io.netty.buffer.ByteBufHolder
```
An object representing a server-sent-event following the SSE specifications A server sent event is composed of the following:
- Event id: This is the last event id seen on the stream this event was received. This can be null, if no id is received.
- Event type: The last seen event type seen on the stream this event was received. This can be null, if no type is received.
- Data: This is the actual event data.
Type
A ServerSentEvent is of the type ServerSentEvent.Type.Data unless it is explicitly passed on creation.
Memory management
This is an implementation of ByteBufHolder so it is required to be explicitly released by calling release() when this instance is no longer required.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ServerSentEvent.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServerSentEvent.Type`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ServerSentEvent(io.netty.buffer.ByteBuf data)`
	`ServerSentEvent(io.netty.buffer.ByteBuf eventId, io.netty.buffer.ByteBuf eventType, io.netty.buffer.ByteBuf data)`
	`ServerSentEvent(ServerSentEvent.Type type, io.netty.buffer.ByteBuf data)`
`protected`	`ServerSentEvent(ServerSentEvent.Type type, io.netty.buffer.ByteBuf eventId, io.netty.buffer.ByteBuf eventType, io.netty.buffer.ByteBuf data)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.netty.buffer.ByteBuf`	`content()`
`java.lang.String`	`contentAsString()`
`io.netty.buffer.ByteBufHolder`	`copy()`
`io.netty.buffer.ByteBufHolder`	`duplicate()`
`io.netty.buffer.ByteBuf`	`getEventId()`
`java.lang.String`	`getEventIdAsString()`
`io.netty.buffer.ByteBuf`	`getEventType()`
`java.lang.String`	`getEventTypeAsString()`
`protected java.nio.charset.Charset`	`getSseCharset()`
`ServerSentEvent.Type`	`getType()` The type of this event.
`boolean`	`hasEventId()`
`boolean`	`hasEventType()`
`int`	`refCnt()`
`boolean`	`release()`
`boolean`	`release(int decrement)`
`io.netty.buffer.ByteBufHolder`	`retain()`
`io.netty.buffer.ByteBufHolder`	`retain(int increment)`
`io.netty.buffer.ByteBufHolder`	`touch()`
`io.netty.buffer.ByteBufHolder`	`touch(java.lang.Object hint)`
`static ServerSentEvent`	`withEventId(io.netty.buffer.ByteBuf eventId, io.netty.buffer.ByteBuf data)` Creates a `ServerSentEvent` instance with an event id.
`static ServerSentEvent`	`withEventIdAndType(io.netty.buffer.ByteBuf eventId, io.netty.buffer.ByteBuf eventType, io.netty.buffer.ByteBuf data)` Creates a `ServerSentEvent` instance with an event id and type.
`static ServerSentEvent`	`withEventType(io.netty.buffer.ByteBuf eventType, io.netty.buffer.ByteBuf data)` Creates a `ServerSentEvent` instance with an event type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerSentEvent

public ServerSentEvent(ServerSentEvent.Type type,
                       io.netty.buffer.ByteBuf data)

ServerSentEvent

public ServerSentEvent(io.netty.buffer.ByteBuf data)

ServerSentEvent

public ServerSentEvent(io.netty.buffer.ByteBuf eventId,
                       io.netty.buffer.ByteBuf eventType,
                       io.netty.buffer.ByteBuf data)

ServerSentEvent

protected ServerSentEvent(ServerSentEvent.Type type,
                          io.netty.buffer.ByteBuf eventId,
                          io.netty.buffer.ByteBuf eventType,
                          io.netty.buffer.ByteBuf data)

Method Detail
- getType
```
public ServerSentEvent.Type getType()
```
  The type of this event. For events which contain an event Id or event type along with data, the type is still ServerSentEvent.Type.Data. The type will be ServerSentEvent.Type.Id or ServerSentEvent.Type.EventType only if the event just contains the event type or event id and no data.
  
  Returns:
  
  Type of this event.
- hasEventId
```
public boolean hasEventId()
```
- hasEventType
```
public boolean hasEventType()
```
- getEventId
```
public io.netty.buffer.ByteBuf getEventId()
```
- getEventIdAsString
```
public java.lang.String getEventIdAsString()
```
- getEventType
```
public io.netty.buffer.ByteBuf getEventType()
```
- getEventTypeAsString
```
public java.lang.String getEventTypeAsString()
```
- contentAsString
```
public java.lang.String contentAsString()
```
- content
```
public io.netty.buffer.ByteBuf content()
```
  Specified by:
  
  content in interface io.netty.buffer.ByteBufHolder
- copy
```
public io.netty.buffer.ByteBufHolder copy()
```
  Specified by:
  
  copy in interface io.netty.buffer.ByteBufHolder
- duplicate
```
public io.netty.buffer.ByteBufHolder duplicate()
```
  Specified by:
  
  duplicate in interface io.netty.buffer.ByteBufHolder
- refCnt
```
public int refCnt()
```
  Specified by:
  
  refCnt in interface io.netty.util.ReferenceCounted
- touch
```
public io.netty.buffer.ByteBufHolder touch()
```
  Specified by:
  
  touch in interface io.netty.buffer.ByteBufHolder
  
  Specified by:
  
  touch in interface io.netty.util.ReferenceCounted
- touch
```
public io.netty.buffer.ByteBufHolder touch(java.lang.Object hint)
```
  Specified by:
  
  touch in interface io.netty.buffer.ByteBufHolder
  
  Specified by:
  
  touch in interface io.netty.util.ReferenceCounted
- retain
```
public io.netty.buffer.ByteBufHolder retain()
```
  Specified by:
  
  retain in interface io.netty.buffer.ByteBufHolder
  
  Specified by:
  
  retain in interface io.netty.util.ReferenceCounted
- retain
```
public io.netty.buffer.ByteBufHolder retain(int increment)
```
  Specified by:
  
  retain in interface io.netty.buffer.ByteBufHolder
  
  Specified by:
  
  retain in interface io.netty.util.ReferenceCounted
- release
```
public boolean release()
```
  Specified by:
  
  release in interface io.netty.util.ReferenceCounted
- release
```
public boolean release(int decrement)
```
  Specified by:
  
  release in interface io.netty.util.ReferenceCounted
- withEventId
```
public static ServerSentEvent withEventId(io.netty.buffer.ByteBuf eventId,
                                          io.netty.buffer.ByteBuf data)
```
  Creates a ServerSentEvent instance with an event id.
  
  Parameters:
  
  eventId - Id for the event.
  
  data - Data for the event.
  
  Returns:
  
  The ServerSentEvent instance.
- withEventType
```
public static ServerSentEvent withEventType(io.netty.buffer.ByteBuf eventType,
                                            io.netty.buffer.ByteBuf data)
```
  Creates a ServerSentEvent instance with an event type.
  
  Parameters:
  
  eventType - Type for the event.
  
  data - Data for the event.
  
  Returns:
  
  The ServerSentEvent instance.
- withEventIdAndType
```
public static ServerSentEvent withEventIdAndType(io.netty.buffer.ByteBuf eventId,
                                                 io.netty.buffer.ByteBuf eventType,
                                                 io.netty.buffer.ByteBuf data)
```
  Creates a ServerSentEvent instance with an event id and type.
  
  Parameters:
  
  eventType - Type for the event.
  
  eventId - Id for the event.
  
  data - Data for the event.
  
  Returns:
  
  The ServerSentEvent instance.
- getSseCharset
```
protected java.nio.charset.Charset getSseCharset()
```

RxJava

Class ServerSentEvent

Type

Memory management

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerSentEvent

ServerSentEvent

ServerSentEvent

ServerSentEvent

Method Detail

getType

hasEventId

hasEventType

getEventId

getEventIdAsString

getEventType

getEventTypeAsString

contentAsString

content

copy

duplicate

refCnt

touch

touch

retain

retain

release

release

withEventId

withEventType

withEventIdAndType

getSseCharset