A B C D E G H I N O P R S T U V W

A

applyGripConfig(List<Map<String, Object>>) - Method in class org.fanout.gripcontrol.GripPubControl

Apply the specified configuration to this GripPubControl instance.

B

binaryContent - Variable in class org.fanout.gripcontrol.WebSocketMessageFormat

body - Variable in class org.fanout.gripcontrol.HttpResponseFormat

body - Variable in class org.fanout.gripcontrol.Response

C

Channel - Class in org.fanout.gripcontrol

The Channel class is used to represent a channel in for a GRIP proxy.

Channel(String) - Constructor for class org.fanout.gripcontrol.Channel

Initialize with the channel name.

Channel(String, String) - Constructor for class org.fanout.gripcontrol.Channel

Initialize with the channel name and an optional previous ID.

charLength(byte[]) - Static method in class org.fanout.gripcontrol.Utilities

Returns the number of UTF-8 characters.

code - Variable in class org.fanout.gripcontrol.HttpResponseFormat

code - Variable in class org.fanout.gripcontrol.Response

content - Variable in class org.fanout.gripcontrol.HttpStreamFormat

content - Variable in class org.fanout.gripcontrol.WebSocketEvent

content - Variable in class org.fanout.gripcontrol.WebSocketMessageFormat

createGripChannelHeader(List<Channel>) - Static method in class org.fanout.gripcontrol.GripControl

Create a GRIP channel header for the specified channels.

createHold(String, List<Channel>, Response, int) - Static method in class org.fanout.gripcontrol.GripControl

Create GRIP hold instructions for the specified parameters including a timeout.

createHoldResponse(List<Channel>) - Static method in class org.fanout.gripcontrol.GripControl

Create a GRIP hold response for HTTP long-polling.

createHoldResponse(List<Channel>, Response) - Static method in class org.fanout.gripcontrol.GripControl

Create a GRIP hold response for HTTP long-polling.

createHoldResponse(List<Channel>, Response, int) - Static method in class org.fanout.gripcontrol.GripControl

Create a GRIP hold response for HTTP long-polling.

createHoldStream(List<Channel>) - Static method in class org.fanout.gripcontrol.GripControl

Create a GRIP hold stream for HTTP streaming.

createHoldStream(List<Channel>, Response) - Static method in class org.fanout.gripcontrol.GripControl

Create a GRIP hold stream for HTTP streaming.

D

decodeWebSocketEvents(String) - Static method in class org.fanout.gripcontrol.GripControl

Decode the request body into an array of WebSocketEvent instances.

E

encodeWebSocketEvents(List<WebSocketEvent>) - Static method in class org.fanout.gripcontrol.GripControl

Encode the specified array of WebSocketEvent instances.

export() - Method in class org.fanout.gripcontrol.HttpResponseFormat

Export the message into the required format.

export() - Method in class org.fanout.gripcontrol.HttpStreamFormat

Export the message into the required format.

export() - Method in class org.fanout.gripcontrol.WebSocketMessageFormat

Exports the message based on whether the message content is binary or not.

G

GripControl - Class in org.fanout.gripcontrol

This class and its features are used in conjunction with GRIP proxies.

GripControl() - Constructor for class org.fanout.gripcontrol.GripControl

GripPubControl - Class in org.fanout.gripcontrol

Allows consumers to publish HTTP format messages to GRIP proxies.

GripPubControl() - Constructor for class org.fanout.gripcontrol.GripPubControl

Initialize with or without a configuration.

GripPubControl(List<Map<String, Object>>) - Constructor for class org.fanout.gripcontrol.GripPubControl

Initialize with a configuration.

H

headers - Variable in class org.fanout.gripcontrol.HttpResponseFormat

headers - Variable in class org.fanout.gripcontrol.Response

HttpResponseFormat - Class in org.fanout.gripcontrol

Used to publish messages to HTTP response clients connected to a GRIP proxy.

HttpResponseFormat(String) - Constructor for class org.fanout.gripcontrol.HttpResponseFormat

Initialize with the body.

HttpResponseFormat(String, Map<String, String>, String, String) - Constructor for class org.fanout.gripcontrol.HttpResponseFormat

Initialize with the body, headers, code and reason.

HttpResponseFormat(byte[]) - Constructor for class org.fanout.gripcontrol.HttpResponseFormat

Initialize with the body.

HttpResponseFormat(byte[], Map<String, String>, String, String) - Constructor for class org.fanout.gripcontrol.HttpResponseFormat

Initialize with the body, headers, code and reason.

HttpStreamAction - Enum in org.fanout.gripcontrol

The available HTTP stream actions.

HttpStreamFormat - Class in org.fanout.gripcontrol

Used to publish messages to HTTP stream clients connected to a GRIP proxy.

HttpStreamFormat(HttpStreamAction) - Constructor for class org.fanout.gripcontrol.HttpStreamFormat

Initialize with an action.

HttpStreamFormat(String) - Constructor for class org.fanout.gripcontrol.HttpStreamFormat

Initialize with string content.

HttpStreamFormat(byte[]) - Constructor for class org.fanout.gripcontrol.HttpStreamFormat

Initialize with byte array content.

I

isClose - Variable in class org.fanout.gripcontrol.HttpStreamFormat

isUtf8(byte[]) - Static method in class org.fanout.gripcontrol.Utilities

Validate a UTF-8 byte array.

N

name - Variable in class org.fanout.gripcontrol.Channel

name() - Method in class org.fanout.gripcontrol.HttpResponseFormat

The name used when publishing this format.

name() - Method in class org.fanout.gripcontrol.HttpStreamFormat

/** The name used when publishing this format.

name() - Method in class org.fanout.gripcontrol.WebSocketMessageFormat

The name used when publishing this format.

O

org.fanout.gripcontrol - package org.fanout.gripcontrol

P

parseGripUri(String) - Static method in class org.fanout.gripcontrol.GripControl

Parse the specified GRIP URI into a config object.

prevId - Variable in class org.fanout.gripcontrol.Channel

publishHttpResponse(List<String>, HttpResponseFormat, String, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP response format message

publishHttpResponse(List<String>, String, String, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP response format message.

publishHttpResponse(List<String>, byte[], String, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP response format message.

publishHttpResponse(List<String>, HttpResponseFormat) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP response format message.

publishHttpResponse(List<String>, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP response format message.

publishHttpResponse(List<String>, byte[]) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP response format message.

publishHttpResponseAsync(List<String>, HttpResponseFormat, String, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP response format message.

publishHttpResponseAsync(List<String>, String, String, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP response format message.

publishHttpResponseAsync(List<String>, byte[], String, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP response format message.

publishHttpResponseAsync(List<String>, HttpResponseFormat, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP response format message.

publishHttpResponseAsync(List<String>, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP response format message.

publishHttpResponseAsync(List<String>, byte[], PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP response format message.

publishHttpStream(List<String>, HttpStreamFormat, String, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP stream format message.

publishHttpStream(List<String>, String, String, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP stream format message.

publishHttpStream(List<String>, byte[], String, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP stream format message.

publishHttpStream(List<String>, HttpStreamFormat) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP stream format message.

publishHttpStream(List<String>, String) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP stream format message.

publishHttpStream(List<String>, byte[]) - Method in class org.fanout.gripcontrol.GripPubControl

Synchronously publish an HTTP stream format message.

publishHttpStreamAsync(List<String>, HttpStreamFormat, String, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP stream format message.

publishHttpStreamAsync(List<String>, String, String, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP stream format message.

publishHttpStreamAsync(List<String>, byte[], String, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP stream format message.

publishHttpStreamAsync(List<String>, HttpStreamFormat, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP stream format message.

publishHttpStreamAsync(List<String>, String, PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP stream format message.

publishHttpStreamAsync(List<String>, byte[], PublishCallback) - Method in class org.fanout.gripcontrol.GripPubControl

Asynchronously publish an HTTP stream format message.

R

reason - Variable in class org.fanout.gripcontrol.HttpResponseFormat

reason - Variable in class org.fanout.gripcontrol.Response

Response - Class in org.fanout.gripcontrol

The Response class is used to represent a set of HTTP response data.

Response(String) - Constructor for class org.fanout.gripcontrol.Response

Initialize with the body.

Response(String, Map<String, String>) - Constructor for class org.fanout.gripcontrol.Response

Initialize with the body and headers.

Response(String, Map<String, String>, String, String) - Constructor for class org.fanout.gripcontrol.Response

Initialize with the body, headers, code and reason.

Response(byte[]) - Constructor for class org.fanout.gripcontrol.Response

Initialize with the body.

Response(byte[], Map<String, String>) - Constructor for class org.fanout.gripcontrol.Response

Initialize with the body and headers.

Response(byte[], Map<String, String>, String, String) - Constructor for class org.fanout.gripcontrol.Response

Initialize with the body, headers, code and reason.

S

splitQuery(URL) - Static method in class org.fanout.gripcontrol.Utilities

Split the query string in the specified URL.

T

type - Variable in class org.fanout.gripcontrol.WebSocketEvent

U

Utilities - Class in org.fanout.gripcontrol

Static utilities used with the GRIP features.

Utilities() - Constructor for class org.fanout.gripcontrol.Utilities

V

validateSig(String, String) - Static method in class org.fanout.gripcontrol.GripControl

Validate the specified JWT token and key.

valueOf(String) - Static method in enum org.fanout.gripcontrol.HttpStreamAction

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.fanout.gripcontrol.HttpStreamAction

Returns an array containing the constants of this enum type, in the order they are declared.

W

webSocketControlMessage(String) - Static method in class org.fanout.gripcontrol.GripControl

Generate a WebSocket control message with the specified type and optional arguments.

webSocketControlMessage(String, Map<String, Object>) - Static method in class org.fanout.gripcontrol.GripControl

Generate a WebSocket control message with the specified type and optional arguments.

WebSocketEvent - Class in org.fanout.gripcontrol

Event information used with the GRIP WebSocket-over-HTTP protocol.

WebSocketEvent(String) - Constructor for class org.fanout.gripcontrol.WebSocketEvent

Initialize with a specified event type.

WebSocketEvent(String, String) - Constructor for class org.fanout.gripcontrol.WebSocketEvent

Initialize with a specified event type and content information.

WebSocketMessageFormat - Class in org.fanout.gripcontrol

Used to publish data to WebSocket clients connected to GRIP proxies.

WebSocketMessageFormat(String) - Constructor for class org.fanout.gripcontrol.WebSocketMessageFormat

Initialize with non-binary string content.

WebSocketMessageFormat(byte[]) - Constructor for class org.fanout.gripcontrol.WebSocketMessageFormat

Initialize with binary content.

A B C D E G H I N O P R S T U V W