com.wowza.wms.httpstreamer.model
Interface IHTTPStreamerSession

All Known Implementing Classes:

com.wowza.wms.httpstreamer.model.HTTPStreamerSessionBase, HTTPStreamerSessionCupertino, HTTPStreamerSessionSanJose, HTTPStreamerSessionSmoothStreamer, HTTPStreamerSessionWebM

public interface IHTTPStreamerSession

IHTTPStreamerSession: HTTP streaming session interface

Field Summary

static int	SESSIONPROTOCOL_COUNT
static int	SESSIONPROTOCOL_CUPERTINOSTREAMING
static int	SESSIONPROTOCOL_SANJOSESTREAMING
static int	SESSIONPROTOCOL_SMOOTHSTREAMING
static int	SESSIONPROTOCOL_UNKNOWN
static int	SESSIONPROTOCOL_WEBMSTREAMING
static int	SESSIONTYPE_LIVE
static int	SESSIONTYPE_UNKNOWN
static int	SESSIONTYPE_VOD

Method Summary

void	acceptSession() Accept the HTTP session.
void	addIOPerformance(IOPerformanceCounter totalIOPerformanceResult) Internal user, keep track of IO performance
void	addIOPerformance2(IOPerformanceCounter totalIOPerformanceResult) Internal user, keep track of IO performance
void	addStreamDomainStr(String streamDomainStr) Internal user, add stream name
void	addStreamDomainStrs(java.util.List<String> streamNames) Internal user, add stream names
boolean	checkAndSetPlayLogged() If play has not been logged return false, else returns true, sets play has been logged
void	clearLoggingValues() Internal user, clear logging values
boolean	containsStreamDomainStr(String streamDomainStr) Internal user, test stream name
boolean	containsStreamNameParts(String streamName) Return true if stream name in stream name parts
IApplicationInstance	getAppInstance() Get the application instance associated with this HTTP session
com.wowza.wms.client.ConnectionHolder	getConnectionHolder() Connection holder for this session
String	getCookieStr() Get cookie string
ElapsedTimer	getElapsedTime() Get the elapsed timer to see how long this session has been running
com.wowza.wms.httpstreamer.model.HTTPStreamerFileInfo	getFileInfo(String streamName) Get the file information if video on demand streaming
IHTTPStreamerAdapter	getHTTPStreamerAdapter() Get the HTTP streaming adapter associated with this HTTP session
IOPerformanceCounter	getIOPerformanceCounter() Get IO performance counter
String	getIpAddress() Get the IP address
String	getLiveStreamingPacketizer() Get the live stream packetizer name
Object	getLock() Get the synchronization lock for this HTTP session
WMSProperties	getProperties() Get the properties associated with this session
String	getQueryStr() Get query string
String	getReferrer() Get referrer
String	getServerIp() Get server IP address
int	getServerPort() Get server port
String	getSessionId() Get session id
int	getSessionProtocol() Get protocol, see SESSIONPROTOCOL_*
int	getSessionTimeout() Get the session timeout for this session (milliseconds)
int	getSessionType() Get session type: see SESSIONTYPE_*
IMediaStream	getStream() Get the IMediaStream associated with this HTTP session
String	getStreamExt() Get stream extension
String	getStreamName() Get stream name
com.wowza.wms.httpstreamer.model.HTTPStreamerStreamNameParts	getStreamNameParts(String streamName) Break the stream name into parts
long	getStreamPosition() Get stream position
String	getTimeRunning() Get the time this session has been running (milliseconds)
double	getTimeRunningSeconds() Get the time this session has been running (seconds)
String	getUri() Get the URI associated with initial request
String	getUserAgent() Get user agent
IVHost	getVHost() Get vhost
boolean	isAcceptSession() Return true if this session has not been rejected
boolean	isActive() Is this session active, false after shutdown
boolean	isFileInfo(String streamName) Return true if the is file information for a given stream name
boolean	isPlayLogged() true, if play has been logged
boolean	isTimeout(long timecode) Return true if this session is timed out.
boolean	isTimeoutSession() Get is session timeout.
boolean	isValidated() Has this session been validated
boolean	isValidStreamDomainStr(String streamDomainStr) Internal user, is stream name valid for HTTP session
void	lockRepeaterStreams(java.util.List<String> streamNames, String liveStreamPacketizer, String liveStreamRepeater, String streamTypeStr) Internal user, lock in reapter streams
void	putFileInfo(String streamName, com.wowza.wms.httpstreamer.model.HTTPStreamerFileInfo fileInfo) Set the file information
void	putStreamNameParts(String streamName, com.wowza.wms.httpstreamer.model.HTTPStreamerStreamNameParts streamNameParts) Add stream name to stream name parts
void	rejectSession() Reject this HTTP session.
void	removeStreamDomainStr(String streamDomainStr) Internal user, remove stream name
void	setAcceptSession(boolean acceptSession) Set to false to reject session
void	setActive(boolean isActive) Set session active
void	setAppInstance(IApplicationInstance appInstance) Set the application instance associated with this HTTP session
void	setCookieStr(String cookieStr) Set cookie string
void	setHTTPStreamerAdapter(IHTTPStreamerAdapter httpStreamerAdapter) Set the HTTP streaming adapter associated with this HTTP session
void	setIpAddress(String ipAddress) Set the IP address
void	setLiveStreamingPacketizer(String liveStreamingPacketizer) Set the live stream packetizer name
void	setPlayLogged(boolean isPlayLogged) true, if play has been logged
void	setQueryStr(String queryStr) Set query string
void	setReferrer(String referrer) Set referrer
void	setServerIp(String serverIp) Set server IP address
void	setServerPort(int serverPort) Set server port
void	setSessionId(String sessionId) Set session id
void	setSessionProtocol(int sessionProtocol) Set protocol, see SESSIONPROTOCOL_*
void	setSessionTimeout(int sessionTimeout) Set the session timeout for this session (milliseconds)
void	setSessionType(int sessionType) Set session type: see SESSIONTYPE_*
void	setStream(IMediaStream stream) Set the IMediaStream associated with this HTTP session
void	setStreamExt(String streamExt) Set stream extension
void	setStreamName(String streamName) Set stream name
void	setStreamPosition(long streamPosition) Set stream position (will not cause seek)
void	setTimeoutSession(boolean timeoutSession) Set is session timeout.
void	setUri(String uri) Set the URI associated with initial request
void	setUserAgent(String userAgent) Set user agent
void	setVHost(IVHost vhost) Set vhost
void	shutdown() Called then the HTTP session is shutting down
void	touch(long timecode) Touch this session to keep it active.
void	updateLoggingValues() Internal user, update logging values

Field Detail

SESSIONPROTOCOL_COUNT

static final int SESSIONPROTOCOL_COUNT

See Also:

Constant Field Values

SESSIONPROTOCOL_CUPERTINOSTREAMING

static final int SESSIONPROTOCOL_CUPERTINOSTREAMING

See Also:

Constant Field Values

SESSIONPROTOCOL_SANJOSESTREAMING

static final int SESSIONPROTOCOL_SANJOSESTREAMING

See Also:

Constant Field Values

SESSIONPROTOCOL_SMOOTHSTREAMING

static final int SESSIONPROTOCOL_SMOOTHSTREAMING

See Also:

Constant Field Values

SESSIONPROTOCOL_UNKNOWN

static final int SESSIONPROTOCOL_UNKNOWN

See Also:

Constant Field Values

SESSIONPROTOCOL_WEBMSTREAMING

static final int SESSIONPROTOCOL_WEBMSTREAMING

See Also:

Constant Field Values

SESSIONTYPE_LIVE

static final int SESSIONTYPE_LIVE

See Also:

Constant Field Values

SESSIONTYPE_UNKNOWN

static final int SESSIONTYPE_UNKNOWN

See Also:

Constant Field Values

SESSIONTYPE_VOD

static final int SESSIONTYPE_VOD

See Also:

Constant Field Values

Method Detail

acceptSession

void acceptSession()

Accept the HTTP session.

addIOPerformance

void addIOPerformance(IOPerformanceCounter totalIOPerformanceResult)

Internal user, keep track of IO performance

Parameters:

totalIOPerformanceResult - IO performance

addIOPerformance2

void addIOPerformance2(IOPerformanceCounter totalIOPerformanceResult)

Internal user, keep track of IO performance

Parameters:

totalIOPerformanceResult - IO performance

addStreamDomainStr

void addStreamDomainStr(String streamDomainStr)

Internal user, add stream name

Parameters:

streamDomainStr - stream name

addStreamDomainStrs

void addStreamDomainStrs(java.util.List<String> streamNames)

Internal user, add stream names

Parameters:

streamNames - stream names

checkAndSetPlayLogged

boolean checkAndSetPlayLogged()

If play has not been logged return false, else returns true, sets play has been logged

Returns:

true, if play has been logged

clearLoggingValues

void clearLoggingValues()

Internal user, clear logging values

containsStreamDomainStr

boolean containsStreamDomainStr(String streamDomainStr)

Internal user, test stream name

Parameters:

streamDomainStr - stream name

Returns:

true if valid

containsStreamNameParts

boolean containsStreamNameParts(String streamName)

Return true if stream name in stream name parts

Parameters:

streamName - stream name

Returns:

true if stream name in stream name parts

getAppInstance

IApplicationInstance getAppInstance()

Get the application instance associated with this HTTP session

Returns:

application instance associated with this HTTP session

getConnectionHolder

com.wowza.wms.client.ConnectionHolder getConnectionHolder()

Connection holder for this session

Returns:

connection holder

getCookieStr

String getCookieStr()

Get cookie string

Returns:

cookie string

getElapsedTime

ElapsedTimer getElapsedTime()

Get the elapsed timer to see how long this session has been running

Returns:

elapsed timer (milliseconds)

getFileInfo

com.wowza.wms.httpstreamer.model.HTTPStreamerFileInfo getFileInfo(String streamName)

Get the file information if video on demand streaming

Parameters:

streamName - stream name

Returns:

file information

getHTTPStreamerAdapter

IHTTPStreamerAdapter getHTTPStreamerAdapter()

Get the HTTP streaming adapter associated with this HTTP session

Returns:

HTTP streaming adapter

getIOPerformanceCounter

IOPerformanceCounter getIOPerformanceCounter()

Get IO performance counter

Returns:

IO performance counter

getIpAddress

String getIpAddress()

Get the IP address

Returns:

IP address

getLiveStreamingPacketizer

String getLiveStreamingPacketizer()

Get the live stream packetizer name

Returns:

live stream packetizer name

getLock

Object getLock()

Get the synchronization lock for this HTTP session

Returns:

synchronization lock

getProperties

WMSProperties getProperties()

Get the properties associated with this session

Returns:

properties

getQueryStr

String getQueryStr()

Get query string

Returns:

query string

getReferrer

String getReferrer()

Get referrer

Returns:

referrer

getServerIp

String getServerIp()

Get server IP address

Returns:

server IP address

getServerPort

int getServerPort()

Get server port

Returns:

server port

getSessionId

String getSessionId()

Get session id

Returns:

session id

getSessionProtocol

int getSessionProtocol()

Get protocol, see SESSIONPROTOCOL_*

Returns:

protocol, see SESSIONPROTOCOL_*

getSessionTimeout

int getSessionTimeout()

Get the session timeout for this session (milliseconds)

Returns:

session timeout for this session (milliseconds)

getSessionType

int getSessionType()

Get session type: see SESSIONTYPE_*

Returns:

session type: see SESSIONTYPE_*

getStream

IMediaStream getStream()

Get the IMediaStream associated with this HTTP session

Returns:

IMediaStream associated with this HTTP session

getStreamExt

String getStreamExt()

Get stream extension

Returns:

stream extension

getStreamName

String getStreamName()

Get stream name

Returns:

stream name

getStreamNameParts

com.wowza.wms.httpstreamer.model.HTTPStreamerStreamNameParts getStreamNameParts(String streamName)

Break the stream name into parts

Parameters:

streamName - stream name

Returns:

stream name parts

getStreamPosition

long getStreamPosition()

Get stream position

Returns:

stream position

getTimeRunning

String getTimeRunning()

Get the time this session has been running (milliseconds)

Returns:

time this session has been running (milliseconds)

getTimeRunningSeconds

double getTimeRunningSeconds()

Get the time this session has been running (seconds)

Returns:

time this session has been running (seconds)

getUri

String getUri()

Get the URI associated with initial request

Returns:

URI associated with initial request

getUserAgent

String getUserAgent()

Get user agent

Returns:

user agent

getVHost

IVHost getVHost()

Get vhost

Returns:

vhost

isAcceptSession

boolean isAcceptSession()

Return true if this session has not been rejected

Returns:

true if this session has not been rejected

isActive

boolean isActive()

Is this session active, false after shutdown

Returns:

true if session is active

isFileInfo

boolean isFileInfo(String streamName)

Return true if the is file information for a given stream name

Parameters:

streamName - stream name

Returns:

true if the is file information for a given stream name

isPlayLogged

boolean isPlayLogged()

true, if play has been logged

Returns:

true, if play has been logged

isTimeout

boolean isTimeout(long timecode)

Return true if this session is timed out.

Parameters:

timecode - last touch - System.currentTimeMillis();

Returns:

true, if timed out

isTimeoutSession

boolean isTimeoutSession()

Get is session timeout.

Returns:

true if this session is timed out

isValidated

boolean isValidated()

Has this session been validated

Returns:

true, if validated

isValidStreamDomainStr

boolean isValidStreamDomainStr(String streamDomainStr)

Internal user, is stream name valid for HTTP session

Parameters:

streamDomainStr - stream name

Returns:

true if valid

lockRepeaterStreams

void lockRepeaterStreams(java.util.List<String> streamNames,
                         String liveStreamPacketizer,
                         String liveStreamRepeater,
                         String streamTypeStr)

Internal user, lock in reapter streams

Parameters:

streamNames - list of stream names

liveStreamPacketizer - live stream packetizer name

liveStreamRepeater - live repeater name

streamTypeStr - stream type

putFileInfo

void putFileInfo(String streamName,
                 com.wowza.wms.httpstreamer.model.HTTPStreamerFileInfo fileInfo)

Set the file information

Parameters:

streamName - stream name

fileInfo - file information

putStreamNameParts

void putStreamNameParts(String streamName,
                        com.wowza.wms.httpstreamer.model.HTTPStreamerStreamNameParts streamNameParts)

Add stream name to stream name parts

Parameters:

streamName - stream name

streamNameParts - stream name parts

rejectSession

void rejectSession()

Reject this HTTP session. No further processing should occur

removeStreamDomainStr

void removeStreamDomainStr(String streamDomainStr)

Internal user, remove stream name

Parameters:

streamDomainStr - stream name

setAcceptSession

void setAcceptSession(boolean acceptSession)

Set to false to reject session

Parameters:

acceptSession - false to reject session

setActive

void setActive(boolean isActive)

Set session active

Parameters:

isActive - session active

setAppInstance

void setAppInstance(IApplicationInstance appInstance)

Set the application instance associated with this HTTP session

Parameters:

appInstance - application instance associated with this HTTP session

setCookieStr

void setCookieStr(String cookieStr)

Set cookie string

Parameters:

cookieStr - cookie string

setHTTPStreamerAdapter

void setHTTPStreamerAdapter(IHTTPStreamerAdapter httpStreamerAdapter)

Set the HTTP streaming adapter associated with this HTTP session

Parameters:

httpStreamerAdapter - HTTP streaming adapter

setIpAddress

void setIpAddress(String ipAddress)

Set the IP address

Parameters:

ipAddress - IP address

setLiveStreamingPacketizer

void setLiveStreamingPacketizer(String liveStreamingPacketizer)

Set the live stream packetizer name

Parameters:

liveStreamingPacketizer - live stream packetizer name

setPlayLogged

void setPlayLogged(boolean isPlayLogged)

true, if play has been logged

Parameters:

isPlayLogged - true, if play has been logged

setQueryStr

void setQueryStr(String queryStr)

Set query string

Parameters:

queryStr - query string

setReferrer

void setReferrer(String referrer)

Set referrer

Parameters:

referrer - referrer

setServerIp

void setServerIp(String serverIp)

Set server IP address

Parameters:

serverIp - server IP address

setServerPort

void setServerPort(int serverPort)

Set server port

Parameters:

serverPort - server port

setSessionId

void setSessionId(String sessionId)

Set session id

Parameters:

sessionId - session id

setSessionProtocol

void setSessionProtocol(int sessionProtocol)

Set protocol, see SESSIONPROTOCOL_*

Parameters:

sessionProtocol - protocol, see SESSIONPROTOCOL_*

setSessionTimeout

void setSessionTimeout(int sessionTimeout)

Set the session timeout for this session (milliseconds)

Parameters:

sessionTimeout - session timeout for this session (milliseconds)

setSessionType

void setSessionType(int sessionType)

Set session type: see SESSIONTYPE_*

Parameters:

sessionType - session type: see SESSIONTYPE_*

setStream

void setStream(IMediaStream stream)

Set the IMediaStream associated with this HTTP session

Parameters:

stream - IMediaStream associated with this HTTP session

setStreamExt

void setStreamExt(String streamExt)

Set stream extension

Parameters:

streamExt - stream extension

setStreamName

void setStreamName(String streamName)

Set stream name

Parameters:

streamName - stream name

setStreamPosition

void setStreamPosition(long streamPosition)

Set stream position (will not cause seek)

Parameters:

streamPosition - stream position

setTimeoutSession

void setTimeoutSession(boolean timeoutSession)

Set is session timeout.

Parameters:

timeoutSession - true if this session is timed out

setUri

void setUri(String uri)

Set the URI associated with initial request

Parameters:

uri - URI associated with initial request

setUserAgent

void setUserAgent(String userAgent)

Set user agent

Parameters:

userAgent - user agent

setVHost

void setVHost(IVHost vhost)

Set vhost

Parameters:

vhost - vhost

shutdown

void shutdown()

Called then the HTTP session is shutting down

touch

void touch(long timecode)

Touch this session to keep it active.

Parameters:

timecode - timecode of touch - System.currentTimeMillis();

updateLoggingValues

void updateLoggingValues()

Internal user, update logging values