com.wowza.wms.http

Interface IHTTPProvider

All Known Subinterfaces:

IHTTPProvider2

All Known Implementing Classes:

HTTPProvider2Base, com.wowza.wms.http.HTTProvider2Base

public interface IHTTPProvider

IHTTPProvider: HTTP provider class for a given HostPort definition. Receive all HTTP requests that are not RTMPT requests. See IHTTPProvider2 for the extended version of this interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCORSHeaders(IHTTPRequest req, IHTTPResponse resp) Called to provide CORS Headers to the output
void	addCORSHeaders(IHTTPResponse resp) Called to provide CORS Headers to the output, no dynamic CORS output
void	addDateHeader(IHTTPResponse resp) Called to provide Date Header to the output
void	addWebSocketSession(IWebSocketSession webSocketSession) Add WebSocket session
int	broadcastWebSocketMessage(WebSocketMessage message) Broadcast a WebSocket message to all connected WebSocket sessions.
int	getWebSocketSessionCount() Get total count of WebSocket sessions for this HTTPProvider
java.util.List<IWebSocketSession>	getWebSocketSessions() Get a list of all WebSocket sessions for this HTTPProvider
void	onBind(IVHost vhost, HostPort hostPort) Triggered after hostPort binds to socket
void	onHTTPRequest(IVHost vhost, IHTTPRequest req, IHTTPResponse resp) Triggered for each HTTP request to the given hostPort that is not an RTMPT request.
void	onUnbind(IVHost vhost, HostPort hostPort) Triggered after hostPort unbinds
boolean	removeWebSocketSession(IWebSocketSession webSocketSession) Remove WebSocket session
void	setProperties(WMSProperties properties) Called to provide properties set in configuration files
boolean	validatePath(String path) Called to check path request is within scope

Method Detail

addCORSHeaders

void addCORSHeaders(IHTTPRequest req,
                  IHTTPResponse resp)

Called to provide CORS Headers to the output

Parameters:

resp -

addCORSHeaders

void addCORSHeaders(IHTTPResponse resp)

Called to provide CORS Headers to the output, no dynamic CORS output

Parameters:

resp -

addDateHeader

void addDateHeader(IHTTPResponse resp)

Called to provide Date Header to the output

Parameters:

resp -

addWebSocketSession

void addWebSocketSession(IWebSocketSession webSocketSession)

Add WebSocket session

Parameters:

webSocketSession - WebSocket session

broadcastWebSocketMessage

int broadcastWebSocketMessage(WebSocketMessage message)

Broadcast a WebSocket message to all connected WebSocket sessions.

Parameters:

message - message to broadcast

Returns:

number of sessions the message was sent to

getWebSocketSessionCount

int getWebSocketSessionCount()

Get total count of WebSocket sessions for this HTTPProvider

Returns:

total count of WebSocket sessions for this HTTPProvider

getWebSocketSessions

java.util.List<IWebSocketSession> getWebSocketSessions()

Get a list of all WebSocket sessions for this HTTPProvider

Returns:

list of all WebSocket sessions

onBind

void onBind(IVHost vhost,
          HostPort hostPort)

Triggered after hostPort binds to socket

Parameters:

vhost - parent vhost

hostPort - host port definition

onHTTPRequest

void onHTTPRequest(IVHost vhost,
                 IHTTPRequest req,
                 IHTTPResponse resp)

Triggered for each HTTP request to the given hostPort that is not an RTMPT request.

Parameters:

vhost - parent vhost

req - HTML requestion object

resp - HTML response object

onUnbind

void onUnbind(IVHost vhost,
            HostPort hostPort)

Triggered after hostPort unbinds

Parameters:

vhost - parent vhost

hostPort - host port definition

removeWebSocketSession

boolean removeWebSocketSession(IWebSocketSession webSocketSession)

Remove WebSocket session

Parameters:

webSocketSession - WebSocket session

Returns:

true, if session removed

setProperties

void setProperties(WMSProperties properties)

Called to provide properties set in configuration files

validatePath

boolean validatePath(String path)

Called to check path request is within scope

Parameters:

path -

Returns: