com.wowza.wms.vhost
Interface IVHost

public interface IVHost

IVHost: public interface to VHost object.

Field Summary

static String	ACCEPTORS_ACCEPTOR Acceptor types: acceptor
static String	ACCEPTORS_HANDLERADAPTER Acceptor types: handler
static int	CODEC_AUDIO_AAC
static int	CODEC_AUDIO_G711_ALAW
static int	CODEC_AUDIO_G711_MULAW
static int	CODEC_AUDIO_MP3
static int	CODEC_AUDIO_MP3_8
static int	CODEC_AUDIO_NELLYMOSER
static int	CODEC_AUDIO_NELLYMOSER_16MONO
static int	CODEC_AUDIO_NELLYMOSER_8MONO
static int	CODEC_AUDIO_PCM_BE
static int	CODEC_AUDIO_PCM_LE
static int	CODEC_AUDIO_PCM_SWF
static int	CODEC_AUDIO_RESERVED
static int	CODEC_AUDIO_SPEEX
static int	CODEC_AUDIO_UNKNOWN
static int	CODEC_AUDIO_VORBIS
static int	CODEC_STREAM_MP2T
static int	CODEC_STREAM_UNKNOWN
static int	CODEC_VIDEO_H264
static int	CODEC_VIDEO_SCREEN
static int	CODEC_VIDEO_SCREEN2
static int	CODEC_VIDEO_SPARK
static int	CODEC_VIDEO_UNKNOWN
static int	CODEC_VIDEO_VP6
static int	CODEC_VIDEO_VP6A
static int	CODEC_VIDEO_VP8
static byte	CONTENTTYPE_AUDIO AMF Content type: audio packet
static byte	CONTENTTYPE_BUFFERSIZE AMF Content type: set buffer size
static byte	CONTENTTYPE_DATA AMF Content type: data packet
static byte	CONTENTTYPE_DATA0 AMF Content type: data packet (AMF0)
static byte	CONTENTTYPE_DATA3 AMF Content type: data packet (AMF3)
static byte	CONTENTTYPE_FUNCTION AMF Content type: function data (AMF0)
static byte	CONTENTTYPE_FUNCTION0 AMF Content type: function data (AMF0)
static byte	CONTENTTYPE_FUNCTION3 AMF Content type: function data (AMF3)
static byte	CONTENTTYPE_MEDIACHUNK AMF Content type: media chunk
static byte	CONTENTTYPE_PLAYCALLBACK AMF Content type: play callback
static byte	CONTENTTYPE_SETCHUNKSIZE AMF Content type: set packet chunk size
static byte	CONTENTTYPE_SHAREDOBJECTS AMF Content type: shared object packet (AMF0)
static byte	CONTENTTYPE_SHAREDOBJECTS0 AMF Content type: shared object packet (AMF0)
static byte	CONTENTTYPE_SHAREDOBJECTS3 AMF Content type: shared object packet (AMF3)
static byte	CONTENTTYPE_UKNOWN AMF Content type: unknown
static byte	CONTENTTYPE_VIDEO AMF Content type: video packet
static byte	CONTENTTYPE_WATCHDOG AMF Content type: watch dog
static int	COUNTER_HTTPCUPERTINO
static int	COUNTER_HTTPSANJOSE
static int	COUNTER_HTTPSMOOTH
static int	COUNTER_HTTPWEBM
static int	COUNTER_RTMP
static int	COUNTER_RTP
static int	COUNTER_TOTAL
static int	FILEFORMAT_FLV
static int	FILEFORMAT_MP4
static int	FILEFORMAT_UNKNOWN
static String	VHOST_DEFAULT

Method Summary

void	addAcceptorListener(IAcceptorNotify acceptorListener) Add acceptor listener.
void	addApplicationListener(IApplicationNotify applicationListener) Add application listener.
void	addIdleWorkerListener(com.wowza.wms.util.IIdleWorkerNotify idleWorkerListener) Add idleWorker listener.
void	addStartupStream(com.wowza.wms.vhost.StartupStream startupStream) Add a stream to the list of streams to start and virtual host startup
boolean	applicationExists(String name) Return true if an application folder exists for this application name
void	closeHostPort(HostPort hostPort, boolean isSuspend) Close an individual HostPort
boolean	createApplication(String sName, String sStreamType, String sContentLoc) Method to create a new application
IApplication	getApplication(String applicationName) Get application by name.
java.util.List	getApplicationFolderNames() Get a list of application folder names
edu.emory.mathcs.backport.java.util.concurrent.locks.WMSReadWriteLock	getApplicationLock() Get the object used in synchronized statements to lock and application.
java.util.List	getApplicationNames() Get a list of application names
int	getApplicationTimeout() Get application time out (milliseconds).
com.wowza.wms.authentication.AuthenticationList	getAuthenticationList() Get the list of available authentication methods
IClient	getClient(int clientId) Get client by client id.
IClient	getClient(int clientId, boolean create) Get client by client id and create if does not exist.
int	getClientCount() Get number of clients connected to this vHost.
int	getClientIdleFrequency() Get default client idle frequency (milliseconds)
int	getClientTimeout() Get client timeout.
ConnectionCounter	getConnectionCounter() Get vHost connection counter.
com.wowza.wms.client.ConnectionCounterSimple	getConnectionCounter(int counterIndex) Get vHost connection counter for a specific technology (see IVHost.COUNTER_*)
int	getConnectionLimit() Get vHost connection limit.
int	getCoreHandlerPoolSize() Get the handler core thread pool size.
int	getCoreTransportPoolSize() Get the transport core thread pool size.
String	getDateStarted() Get date and time the server was started.
java.util.Properties	getDynamicLogProperties() Get the dynamic log properties defined at the vhost level in conf/log4j.properties
int	getFileIOPoolSize() Get the default file io pool size.
ThreadPool	getHandlerThreadPool() Get the VHost handler thread pool.
String	getHomePath() Get vHost configuration path.
HostPortList	getHostPortsList() Get list of host port definitions for vHost.
IHTTPStreamerAdapter	getHTTPStreamerAdapter(String ID) Get an HTTPStreamerAdapter by ID
java.util.List<String>	getHTTPStreamerAdapterIDs() Get a list of HTTPStreamerAdapter IDs
com.wowza.wms.httpstreamer.model.HTTPStreamerContext	getHTTPStreamerContext() Get the HTTPStreamer (Cupertino Streaming and Silverlight Smooth Streaming) host context
com.wowza.wms.httpstreamer.model.HTTPStreamerList	getHTTPStreamerList() Get the list of HTTPStreamers
int	getIdleCheckFrequency() Get idle check frequency (milliseconds)
int	getIdleMinimumWaitTime() Get the minimum time (milliseconds) the idle worker thread will sleep before generating idle events
int	getIdleWorkerCount() Get number of threads used to generate idle events
com.wowza.wms.util.IdleWorkersUtil	getIdleWorkers() Get the idle worker utility
IOPerformanceCounter	getIoPerformanceCounter() Get vHost IO performance counter.
IOPerformanceCounter	getIoPerformanceCounter(int counterIndex) Get vHost IO performance counter for a specific technology (see IVHost.COUNTER_*)
com.wowza.io.IOScheduler	getIOScheduler() Get IO scheduler for vHost.
int	getKeepAliveTimeout() Get the RTMPT connection keep alive timeout
com.wowza.wms.stream.livepacketizer.LiveStreamPacketizerList	getLiveStreamPacketizerList() Get the LiveStreamPacketizerList
int	getMaximumPendingWriteBytes() Get maximum number a bytes a client connection can have waiting to be sent before the connection is terminated.
int	getMaximumSetBufferTime() Get maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call.
MediaCasterList	getMediaCasterList() Get the list of media caster definitions (MediaCaster.xml)
MediaCasterSettings	getMediaCasterSettings() Get the media caster settings
com.wowza.wms.stream.MediaReaderList	getMediaReaders() Get the media readers attached to vHost (MediaReaders.xml).
com.wowza.wms.stream.MediaWriterList	getMediaWriters() Get the media writers attached to vHost (MediaWriters.xml).
java.util.Map	getMp3TagMap() Get MP3 tag map attached to vHost (MP3Tags.xml).
String	getName() Get vHost name
com.wowza.wms.vhost.HostPortConfig	getNetConnectionHostPortConfig() Get the socket configuration for server to server connections
int	getNetConnectionIdleFrequency() Get server to server idle frequency (milliseconds)
int	getNetConnectionProcessorCount() Get net connection processor count.
int	getNextNetConnectionId() Get next connection id.
int	getPingTimeout() Get ping timeout (milliseconds)
WMSProperties	getProperties() Get properties attached to this vHost.
String	getProperty(String key) Get virtual host property.
RTPContext	getRTPContext() Get the RTP (real time protocol) virtual host context
com.wowza.wms.rtp.transport.RTPUDPDatagramConfig	getRTPDatagramConfigIncoming() Get the RTP Datagram Socket configuration
com.wowza.wms.rtp.transport.RTPUDPDatagramConfig	getRTPDatagramConfigOutgoing() Get the RTP Datagram Socket configuration
int	getRTPIdleFrequency() Get default RTP idle frequency (milliseconds)
java.util.List<com.wowza.wms.vhost.StartupStream>	getStartupStreams() Get the list of streams to start at virtual host startup
StreamList	getStreamTypes() Get default stream type.
ThreadPool	getThreadPool() Get the VHost handler thread pool.
String	getTimeRunning() Get the time vHost has been running.
double	getTimeRunningSeconds() Get time running in seconds
ThreadPool	getTransportThreadPool() Get the VHost transport thread pool.
com.wowza.wms.rtp.transport.UDPTransportManager	getUDPTransportManager() Get the UDP transport manager.
int	getValidationFrequency() Get time between validation pings (milliseconds)
void	init(String basePath) Initialize vHost.
boolean	isApplicationLoaded(String applicationName) Return true is the application is loaded
boolean	isShuttingDown() Is the VHost shutting down
boolean	isStartStarupStreams() Returns true if the startup streams are to start and vhost startup
boolean	isSuspended() Returns true is all HostPorts connected to this VHost are suspended
void	killClient(int clientId) Remove client from vHost and send disconnect message.
void	killRTSPSession(String rtspSessionId) Kill an RTSP connection by the RTSP session id
void	putHTTPStreamerAdapter(String ID, IHTTPStreamerAdapter adapter) Add an HTTPStreamerAdapter
String	readVHostConfig(String sName) Method to read xml config file..
void	removeAcceptorListener(IAcceptorNotify acceptorListener) Remove acceptor listener.
boolean	removeApplication(String sName) Method to remove an application
void	removeApplicationListener(IApplicationNotify applicationListener) Remove applation listener.
void	removeClient(int clientId) Remove client from vHost.
void	removeIdleWorkerListener(com.wowza.wms.util.IIdleWorkerNotify idleWorkerListener) Remove idleWorker listener
void	reparentClient(IClient client) Move a client object to a new vhost.
void	setAdminInterfaceHostPort(HostPort adminInterfaceHostPort) Set admin interface host port (not used)
void	setApplicationTimeout(int applicationTimeout) Set application time out (milliseconds).
void	setClientIdleFrequency(int clientIdleFrequency) Set default client idle frequency (milliseconds)
void	setClientTimeout(int clientTimeout) Set client timeout.
void	setCoreHandlerPoolSize(int corePoolSize) Set the handler core thread pool size.
void	setCoreTransportPoolSize(int corePoolSize) Set the transport core thread pool size.
void	setDynamicLogProperties(java.util.Properties dynamicLogProperties) Set the dynamic log properties set at the vhost level
void	setFileIOPoolSize(int fileIOPoolSize) Set default file io thread pool size.
void	setIdleCheckFrequency(int idleCheckFrequency) Set idle check frequency (milliseconds)
void	setIdleMinimumWaitTime(int idleMinimumWaitTime) Set the minimum time (milliseconds) the idle worker thread will sleep before generating idle events
void	setIdleWorkerCount(int idleWorkerCount) Set number of threads used to generate idle events
void	setKeepAliveTimeout(int keepAliveTimeout) Set the RTMPT connection keep alive timeout
void	setMaximumPendingWriteBytes(int maximumPendingWriteBytes) Set maximum number a bytes a client connection can have waiting to be sent before the connection is terminated.
void	setMaximumSetBufferTime(int maximumSetBufferTime) Set maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call.
void	setNetConnectionIdleFrequency(int netConnectionIdleFrequency) Set the server to server idle frequency (milliseconds)
void	setNetConnectionProcessorCount(int netConnectionProcessorCount) Set net connection processor count.
void	setPingTimeout(int pingTimeout) Set ping timeout (millseconds)
void	setRTPIdleFrequency(int rtpIdleFrequency) Set default RTP idle frequency (milliseconds)
void	setShuttingDown(boolean shuttingDown) Set VHost shutting down flag
void	setStartStarupStreams(boolean startStarupStreams) Set to true to startup startup stream as vhost startup
void	setValidationFrequency(int validationFrequency) Set time between validation pings (milliseconds)
void	shutdown() Shutdown.
void	shutdownApplication(String appName) Shutdown an application by name.
boolean	startApplicationInstance(String appName) Start an application instance.
boolean	startApplicationInstance(String appName, String appInstanceName) Start an application instance.
void	startStartupStreams() Method to start startup streams
void	stopStartupStreams() Method to stop startup streams
void	suspendAllHostPorts() Suspend all HostPorts from accepting new connections.
boolean	touchApplicationInstance(String appName) Start an application instance if it is not already started then touch it so it stays loaded for at least 3 seconds.
boolean	touchApplicationInstance(String appName, String appInstanceName) Start an application instance if it is not already started then touch it so it stays loaded for at least 3 seconds.
void	unbindAllHostPorts() Unbind all HostPorts and drop all connections
void	updateLoggingDuration() Internal: update the internal logging values.
boolean	writeVHostConfig(String sName, String data) Method to write xml config file..

Field Detail

ACCEPTORS_ACCEPTOR

static final String ACCEPTORS_ACCEPTOR

Acceptor types: acceptor

See Also:

Constant Field Values

ACCEPTORS_HANDLERADAPTER

static final String ACCEPTORS_HANDLERADAPTER

Acceptor types: handler

See Also:

Constant Field Values

CODEC_AUDIO_AAC

static final int CODEC_AUDIO_AAC

See Also:

Constant Field Values

CODEC_AUDIO_G711_ALAW

static final int CODEC_AUDIO_G711_ALAW

See Also:

Constant Field Values

CODEC_AUDIO_G711_MULAW

static final int CODEC_AUDIO_G711_MULAW

See Also:

Constant Field Values

CODEC_AUDIO_MP3

static final int CODEC_AUDIO_MP3

See Also:

Constant Field Values

CODEC_AUDIO_MP3_8

static final int CODEC_AUDIO_MP3_8

See Also:

Constant Field Values

CODEC_AUDIO_NELLYMOSER

static final int CODEC_AUDIO_NELLYMOSER

See Also:

Constant Field Values

CODEC_AUDIO_NELLYMOSER_16MONO

static final int CODEC_AUDIO_NELLYMOSER_16MONO

See Also:

Constant Field Values

CODEC_AUDIO_NELLYMOSER_8MONO

static final int CODEC_AUDIO_NELLYMOSER_8MONO

See Also:

Constant Field Values

CODEC_AUDIO_PCM_BE

static final int CODEC_AUDIO_PCM_BE

See Also:

Constant Field Values

CODEC_AUDIO_PCM_LE

static final int CODEC_AUDIO_PCM_LE

See Also:

Constant Field Values

CODEC_AUDIO_PCM_SWF

static final int CODEC_AUDIO_PCM_SWF

See Also:

Constant Field Values

CODEC_AUDIO_RESERVED

static final int CODEC_AUDIO_RESERVED

See Also:

Constant Field Values

CODEC_AUDIO_SPEEX

static final int CODEC_AUDIO_SPEEX

See Also:

Constant Field Values

CODEC_AUDIO_UNKNOWN

static final int CODEC_AUDIO_UNKNOWN

See Also:

Constant Field Values

CODEC_AUDIO_VORBIS

static final int CODEC_AUDIO_VORBIS

See Also:

Constant Field Values

CODEC_STREAM_MP2T

static final int CODEC_STREAM_MP2T

See Also:

Constant Field Values

CODEC_STREAM_UNKNOWN

static final int CODEC_STREAM_UNKNOWN

See Also:

Constant Field Values

CODEC_VIDEO_H264

static final int CODEC_VIDEO_H264

See Also:

Constant Field Values

CODEC_VIDEO_SCREEN

static final int CODEC_VIDEO_SCREEN

See Also:

Constant Field Values

CODEC_VIDEO_SCREEN2

static final int CODEC_VIDEO_SCREEN2

See Also:

Constant Field Values

CODEC_VIDEO_SPARK

static final int CODEC_VIDEO_SPARK

See Also:

Constant Field Values

CODEC_VIDEO_UNKNOWN

static final int CODEC_VIDEO_UNKNOWN

See Also:

Constant Field Values

CODEC_VIDEO_VP6

static final int CODEC_VIDEO_VP6

See Also:

Constant Field Values

CODEC_VIDEO_VP6A

static final int CODEC_VIDEO_VP6A

See Also:

Constant Field Values

CODEC_VIDEO_VP8

static final int CODEC_VIDEO_VP8

See Also:

Constant Field Values

CONTENTTYPE_AUDIO

static final byte CONTENTTYPE_AUDIO

AMF Content type: audio packet

See Also:

Constant Field Values

CONTENTTYPE_BUFFERSIZE

static final byte CONTENTTYPE_BUFFERSIZE

AMF Content type: set buffer size

See Also:

Constant Field Values

CONTENTTYPE_DATA

static final byte CONTENTTYPE_DATA

AMF Content type: data packet

See Also:

Constant Field Values

CONTENTTYPE_DATA0

static final byte CONTENTTYPE_DATA0

AMF Content type: data packet (AMF0)

See Also:

Constant Field Values

CONTENTTYPE_DATA3

static final byte CONTENTTYPE_DATA3

AMF Content type: data packet (AMF3)

See Also:

Constant Field Values

CONTENTTYPE_FUNCTION

static final byte CONTENTTYPE_FUNCTION

AMF Content type: function data (AMF0)

See Also:

Constant Field Values

CONTENTTYPE_FUNCTION0

static final byte CONTENTTYPE_FUNCTION0

AMF Content type: function data (AMF0)

See Also:

Constant Field Values

CONTENTTYPE_FUNCTION3

static final byte CONTENTTYPE_FUNCTION3

AMF Content type: function data (AMF3)

See Also:

Constant Field Values

CONTENTTYPE_MEDIACHUNK

static final byte CONTENTTYPE_MEDIACHUNK

AMF Content type: media chunk

See Also:

Constant Field Values

CONTENTTYPE_PLAYCALLBACK

static final byte CONTENTTYPE_PLAYCALLBACK

AMF Content type: play callback

See Also:

Constant Field Values

CONTENTTYPE_SETCHUNKSIZE

static final byte CONTENTTYPE_SETCHUNKSIZE

AMF Content type: set packet chunk size

See Also:

Constant Field Values

CONTENTTYPE_SHAREDOBJECTS

static final byte CONTENTTYPE_SHAREDOBJECTS

AMF Content type: shared object packet (AMF0)

See Also:

Constant Field Values

CONTENTTYPE_SHAREDOBJECTS0

static final byte CONTENTTYPE_SHAREDOBJECTS0

AMF Content type: shared object packet (AMF0)

See Also:

Constant Field Values

CONTENTTYPE_SHAREDOBJECTS3

static final byte CONTENTTYPE_SHAREDOBJECTS3

AMF Content type: shared object packet (AMF3)

See Also:

Constant Field Values

CONTENTTYPE_UKNOWN

static final byte CONTENTTYPE_UKNOWN

AMF Content type: unknown

See Also:

Constant Field Values

CONTENTTYPE_VIDEO

static final byte CONTENTTYPE_VIDEO

AMF Content type: video packet

See Also:

Constant Field Values

CONTENTTYPE_WATCHDOG

static final byte CONTENTTYPE_WATCHDOG

AMF Content type: watch dog

See Also:

Constant Field Values

COUNTER_HTTPCUPERTINO

static final int COUNTER_HTTPCUPERTINO

See Also:

Constant Field Values

COUNTER_HTTPSANJOSE

static final int COUNTER_HTTPSANJOSE

See Also:

Constant Field Values

COUNTER_HTTPSMOOTH

static final int COUNTER_HTTPSMOOTH

See Also:

Constant Field Values

COUNTER_HTTPWEBM

static final int COUNTER_HTTPWEBM

See Also:

Constant Field Values

COUNTER_RTMP

static final int COUNTER_RTMP

See Also:

Constant Field Values

COUNTER_RTP

static final int COUNTER_RTP

See Also:

Constant Field Values

COUNTER_TOTAL

static final int COUNTER_TOTAL

See Also:

Constant Field Values

FILEFORMAT_FLV

static final int FILEFORMAT_FLV

See Also:

Constant Field Values

FILEFORMAT_MP4

static final int FILEFORMAT_MP4

See Also:

Constant Field Values

FILEFORMAT_UNKNOWN

static final int FILEFORMAT_UNKNOWN

See Also:

Constant Field Values

VHOST_DEFAULT

static final String VHOST_DEFAULT

See Also:

Constant Field Values

Method Detail

addAcceptorListener

void addAcceptorListener(IAcceptorNotify acceptorListener)

Add acceptor listener. Acceptor listeners will receive the following events: onAcceptorCreate, onAcceptorDestroy.

Parameters:

acceptorListener - acceptor listener

addApplicationListener

void addApplicationListener(IApplicationNotify applicationListener)

Add application listener. An application listener will receive the following events: onApplicationCreate, onApplicationDestroy.

Parameters:

applicationListener - application listener

addIdleWorkerListener

void addIdleWorkerListener(com.wowza.wms.util.IIdleWorkerNotify idleWorkerListener)

Add idleWorker listener. An idleWorker listener will receive the following events: onIdleWorkerCreate, onIdleWorkerDestroy.

Parameters:

idleWorkerListener - idleWorker listener

addStartupStream

void addStartupStream(com.wowza.wms.vhost.StartupStream startupStream)

Add a stream to the list of streams to start and virtual host startup

Parameters:

startupStream - startup stream

applicationExists

boolean applicationExists(String name)

Return true if an application folder exists for this application name

Parameters:

name - application name

Returns:

true if an application folder exists for this application name

closeHostPort

void closeHostPort(HostPort hostPort,
                   boolean isSuspend)

Close an individual HostPort

Parameters:

hostPort - host port to close

isSuspend - if true will just suspend the HostPort from accepting new connections, if false will unbind and drop all connections

createApplication

boolean createApplication(String sName,
                          String sStreamType,
                          String sContentLoc)

Method to create a new application

getApplication

IApplication getApplication(String applicationName)

Get application by name.

Parameters:

applicationName - application name

Returns:

application

getApplicationFolderNames

java.util.List getApplicationFolderNames()

Get a list of application folder names

Returns:

list of application folder names

getApplicationLock

edu.emory.mathcs.backport.java.util.concurrent.locks.WMSReadWriteLock getApplicationLock()

Get the object used in synchronized statements to lock and application.

Returns:

object used in synchronized statements to lock and application

getApplicationNames

java.util.List getApplicationNames()

Get a list of application names

Returns:

list of application names

getApplicationTimeout

int getApplicationTimeout()

Get application time out (milliseconds). Time from last client disconnect to application destruction.

Returns:

application time out (milliseconds)

getAuthenticationList

com.wowza.wms.authentication.AuthenticationList getAuthenticationList()

Get the list of available authentication methods

Returns:

list of available authentication methods

getClient

IClient getClient(int clientId)

Get client by client id.

Parameters:

clientId - client id

Returns:

client

getClient

IClient getClient(int clientId,
                  boolean create)

Get client by client id and create if does not exist.

Parameters:

clientId - client id

create - create if does not exist

Returns:

client

getClientCount

int getClientCount()

Get number of clients connected to this vHost.

Returns:

number of clients connected to this vHost

getClientIdleFrequency

int getClientIdleFrequency()

Get default client idle frequency (milliseconds)

Returns:

default client idle frequency (milliseconds)

getClientTimeout

int getClientTimeout()

Get client timeout.

Returns:

client timeout

getConnectionCounter

ConnectionCounter getConnectionCounter()

Get vHost connection counter.

Returns:

connection counter

getConnectionCounter

com.wowza.wms.client.ConnectionCounterSimple getConnectionCounter(int counterIndex)

Get vHost connection counter for a specific technology (see IVHost.COUNTER_*)

Parameters:

counterIndex - counter index (see IVHost.COUNTER_*)

Returns:

connection counter

getConnectionLimit

int getConnectionLimit()

Get vHost connection limit.

Returns:

vHost connection limit

getCoreHandlerPoolSize

int getCoreHandlerPoolSize()

Get the handler core thread pool size.

Returns:

default core thread pool size

getCoreTransportPoolSize

int getCoreTransportPoolSize()

Get the transport core thread pool size.

Returns:

default core thread pool size

getDateStarted

String getDateStarted()

Get date and time the server was started.

Returns:

date and time the server was started

getDynamicLogProperties

java.util.Properties getDynamicLogProperties()

Get the dynamic log properties defined at the vhost level in conf/log4j.properties

Returns:

dynamic log properties defined at the vhost level

getFileIOPoolSize

int getFileIOPoolSize()

Get the default file io pool size.

Returns:

default file io pool size

getHandlerThreadPool

ThreadPool getHandlerThreadPool()

Get the VHost handler thread pool. This thread pool is used to process the incoming events.

Returns:

VHost handler thread pool

getHomePath

String getHomePath()

Get vHost configuration path.

Returns:

configuration path

getHostPortsList

HostPortList getHostPortsList()

Get list of host port definitions for vHost.

Returns:

list of host port definitions for vHost

getHTTPStreamerAdapter

IHTTPStreamerAdapter getHTTPStreamerAdapter(String ID)

Get an HTTPStreamerAdapter by ID

Parameters:

ID - HTTPStreamerAdapter ID

Returns:

HTTPStreamerAdapter

getHTTPStreamerAdapterIDs

java.util.List<String> getHTTPStreamerAdapterIDs()

Get a list of HTTPStreamerAdapter IDs

Returns:

list of HTTPStreamerAdapter IDs

getHTTPStreamerContext

com.wowza.wms.httpstreamer.model.HTTPStreamerContext getHTTPStreamerContext()

Get the HTTPStreamer (Cupertino Streaming and Silverlight Smooth Streaming) host context

Returns:

HTTPStreamer (Cupertino Streaming and Silverlight Smooth Streaming) host context

getHTTPStreamerList

com.wowza.wms.httpstreamer.model.HTTPStreamerList getHTTPStreamerList()

Get the list of HTTPStreamers

Returns:

list of HTTPStreamers

getIdleCheckFrequency

int getIdleCheckFrequency()

Get idle check frequency (milliseconds)

Returns:

idle check frequency (milliseconds)

getIdleMinimumWaitTime

int getIdleMinimumWaitTime()

Get the minimum time (milliseconds) the idle worker thread will sleep before generating idle events

Returns:

minimum time (milliseconds) the idle worker thread will sleep before generating idle events

getIdleWorkerCount

int getIdleWorkerCount()

Get number of threads used to generate idle events

Returns:

number of threads used to generate idle events

getIdleWorkers

com.wowza.wms.util.IdleWorkersUtil getIdleWorkers()

Get the idle worker utility

Returns:

idle worker utility

getIoPerformanceCounter

IOPerformanceCounter getIoPerformanceCounter()

Get vHost IO performance counter.

Returns:

io performance counter

getIoPerformanceCounter

IOPerformanceCounter getIoPerformanceCounter(int counterIndex)

Get vHost IO performance counter for a specific technology (see IVHost.COUNTER_*)

Parameters:

counterIndex - counter index (see IVHost.COUNTER_*)

Returns:

io performance counter

getIOScheduler

com.wowza.io.IOScheduler getIOScheduler()

Get IO scheduler for vHost. IO scheduler is used to schedule reads from the disk to increase server throughput for static flv serving.

Returns:

IO scheduler for vHost

getKeepAliveTimeout

int getKeepAliveTimeout()

Get the RTMPT connection keep alive timeout

Returns:

RTMPT connection keep alive timeout

getLiveStreamPacketizerList

com.wowza.wms.stream.livepacketizer.LiveStreamPacketizerList getLiveStreamPacketizerList()

Get the LiveStreamPacketizerList

Returns:

LiveStreamPacketizerList

getMaximumPendingWriteBytes

int getMaximumPendingWriteBytes()

Get maximum number a bytes a client connection can have waiting to be sent before the connection is terminated. If set to zero this feature is turned off.

Returns:

maximum number a bytes a client connection can have waiting to be sent before the connection is terminated

getMaximumSetBufferTime

int getMaximumSetBufferTime()

Get maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call. If set to zero this feature is turned off.

Returns:

maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call

getMediaCasterList

MediaCasterList getMediaCasterList()

Get the list of media caster definitions (MediaCaster.xml)

Returns:

list of media caster definitions

getMediaCasterSettings

MediaCasterSettings getMediaCasterSettings()

Get the media caster settings

Returns:

media caster settings

getMediaReaders

com.wowza.wms.stream.MediaReaderList getMediaReaders()

Get the media readers attached to vHost (MediaReaders.xml).

Returns:

media readers attached to vHost

getMediaWriters

com.wowza.wms.stream.MediaWriterList getMediaWriters()

Get the media writers attached to vHost (MediaWriters.xml).

Returns:

media writers attached to vHost

getMp3TagMap

java.util.Map getMp3TagMap()

Get MP3 tag map attached to vHost (MP3Tags.xml).

Returns:

MP3 tag map attached to vHost

getName

String getName()

Get vHost name

Returns:

vHost name

getNetConnectionHostPortConfig

com.wowza.wms.vhost.HostPortConfig getNetConnectionHostPortConfig()

Get the socket configuration for server to server connections

Returns:

socket configuration for server to server connections

getNetConnectionIdleFrequency

int getNetConnectionIdleFrequency()

Get server to server idle frequency (milliseconds)

Returns:

server to server idle frequency (milliseconds)

getNetConnectionProcessorCount

int getNetConnectionProcessorCount()

Get net connection processor count. Number of threads used for server to server communication (not finished).

Returns:

net connection processor count

getNextNetConnectionId

int getNextNetConnectionId()

Get next connection id.

Returns:

next connection id

getPingTimeout

int getPingTimeout()

Get ping timeout (milliseconds)

Returns:

ping timeout (milliseconds)

getProperties

WMSProperties getProperties()

Get properties attached to this vHost.

Returns:

properties attached to this vHost

getProperty

String getProperty(String key)

Get virtual host property.

Parameters:

key - key

Returns:

property value or null if does not exist

getRTPContext

RTPContext getRTPContext()

Get the RTP (real time protocol) virtual host context

Returns:

RTP (real time protocol) virtual host context

getRTPDatagramConfigIncoming

com.wowza.wms.rtp.transport.RTPUDPDatagramConfig getRTPDatagramConfigIncoming()

Get the RTP Datagram Socket configuration

Returns:

RTP Datagram Socket configuration

getRTPDatagramConfigOutgoing

com.wowza.wms.rtp.transport.RTPUDPDatagramConfig getRTPDatagramConfigOutgoing()

Get the RTP Datagram Socket configuration

Returns:

RTP Datagram Socket configuration

getRTPIdleFrequency

int getRTPIdleFrequency()

Get default RTP idle frequency (milliseconds)

Returns:

default RTP idle frequency (milliseconds)

getStartupStreams

java.util.List<com.wowza.wms.vhost.StartupStream> getStartupStreams()

Get the list of streams to start at virtual host startup

Returns:

list of streams to start at virtual host startup

getStreamTypes

StreamList getStreamTypes()

Get default stream type.

Returns:

default stream type

getThreadPool

ThreadPool getThreadPool()

Get the VHost handler thread pool. Same as getHandlerThreadPool.

Returns:

VHost handler thread pool

getTimeRunning

String getTimeRunning()

Get the time vHost has been running.

Returns:

formatted string with vHost uptime

getTimeRunningSeconds

double getTimeRunningSeconds()

Get time running in seconds

Returns:

time running in seconds

getTransportThreadPool

ThreadPool getTransportThreadPool()

Get the VHost transport thread pool. This thread pool is used to read/write data from the transports sockets.

Returns:

VHost transport thread pool

getUDPTransportManager

com.wowza.wms.rtp.transport.UDPTransportManager getUDPTransportManager()

Get the UDP transport manager.

Returns:

UDP transport manager

getValidationFrequency

int getValidationFrequency()

Get time between validation pings (milliseconds)

Returns:

time between validation pings (milliseconds)

init

void init(String basePath)

Initialize vHost.

Parameters:

basePath - base path to configuration files

isApplicationLoaded

boolean isApplicationLoaded(String applicationName)

Return true is the application is loaded

Parameters:

applicationName - application name

Returns:

true if application is loaded

isShuttingDown

boolean isShuttingDown()

Is the VHost shutting down

Returns:

true if the vhost is shutting down

isStartStarupStreams

boolean isStartStarupStreams()

Returns true if the startup streams are to start and vhost startup

Returns:

true if the startup streams are to start and vhost startup

isSuspended

boolean isSuspended()

Returns true is all HostPorts connected to this VHost are suspended

killClient

void killClient(int clientId)

Remove client from vHost and send disconnect message.

Parameters:

clientId - client id

killRTSPSession

void killRTSPSession(String rtspSessionId)

Kill an RTSP connection by the RTSP session id

Parameters:

rtspSessionId - RTSP session id

putHTTPStreamerAdapter

void putHTTPStreamerAdapter(String ID,
                            IHTTPStreamerAdapter adapter)

Add an HTTPStreamerAdapter

Parameters:

ID - HTTPStreamerAdapter ID

adapter - HTTPStreamerAdapter

readVHostConfig

String readVHostConfig(String sName)

Method to read xml config file..

removeAcceptorListener

void removeAcceptorListener(IAcceptorNotify acceptorListener)

Remove acceptor listener.

Parameters:

acceptorListener - acceptor listener

removeApplication

boolean removeApplication(String sName)

Method to remove an application

removeApplicationListener

void removeApplicationListener(IApplicationNotify applicationListener)

Remove applation listener.

Parameters:

applicationListener - applation listener

removeClient

void removeClient(int clientId)

Remove client from vHost.

Parameters:

clientId - client id

removeIdleWorkerListener

void removeIdleWorkerListener(com.wowza.wms.util.IIdleWorkerNotify idleWorkerListener)

Remove idleWorker listener

Parameters:

idleWorkerListener - idleWorker listener

reparentClient

void reparentClient(IClient client)

Move a client object to a new vhost. This can only be done right after the handshake process has completed. See IVHostNotify.onVHostClientConnect.

Parameters:

client - client object to move

setAdminInterfaceHostPort

void setAdminInterfaceHostPort(HostPort adminInterfaceHostPort)

Set admin interface host port (not used)

Parameters:

adminInterfaceHostPort - admin interface host port

setApplicationTimeout

void setApplicationTimeout(int applicationTimeout)

Set application time out (milliseconds).

Parameters:

applicationTimeout - application time out (milliseconds)

setClientIdleFrequency

void setClientIdleFrequency(int clientIdleFrequency)

Set default client idle frequency (milliseconds)

Parameters:

clientIdleFrequency - default client idle frequency (milliseconds)

setClientTimeout

void setClientTimeout(int clientTimeout)

Set client timeout. An inactive client connected by RTMPT protocol will be deleted after this timeout.

Parameters:

clientTimeout - client timeout

setCoreHandlerPoolSize

void setCoreHandlerPoolSize(int corePoolSize)

Set the handler core thread pool size.

Parameters:

corePoolSize - core thread pool size

setCoreTransportPoolSize

void setCoreTransportPoolSize(int corePoolSize)

Set the transport core thread pool size.

Parameters:

corePoolSize - core thread pool size

setDynamicLogProperties

void setDynamicLogProperties(java.util.Properties dynamicLogProperties)

Set the dynamic log properties set at the vhost level

Parameters:

dynamicLogProperties - dynamic log properties defined at the vhost level

setFileIOPoolSize

void setFileIOPoolSize(int fileIOPoolSize)

Set default file io thread pool size.

Parameters:

fileIOPoolSize - default file io thread pool size

setIdleCheckFrequency

void setIdleCheckFrequency(int idleCheckFrequency)

Set idle check frequency (milliseconds)

Parameters:

idleCheckFrequency - idle check frequency (milliseconds)

setIdleMinimumWaitTime

void setIdleMinimumWaitTime(int idleMinimumWaitTime)

Set the minimum time (milliseconds) the idle worker thread will sleep before generating idle events

Parameters:

idleMinimumWaitTime - minimum time (milliseconds) the idle worker thread will sleep before generating idle events

setIdleWorkerCount

void setIdleWorkerCount(int idleWorkerCount)

Set number of threads used to generate idle events

Parameters:

idleWorkerCount - number of threads used to generate idle events

setKeepAliveTimeout

void setKeepAliveTimeout(int keepAliveTimeout)

Set the RTMPT connection keep alive timeout

Parameters:

keepAliveTimeout - RTMPT connection keep alive timeout

setMaximumPendingWriteBytes

void setMaximumPendingWriteBytes(int maximumPendingWriteBytes)

Set maximum number a bytes a client connection can have waiting to be sent before the connection is terminated. If set to zero this feature is turned off.

Parameters:

maximumPendingWriteBytes - maximum number a bytes a client connection can have waiting to be sent before the connection is terminated

setMaximumSetBufferTime

void setMaximumSetBufferTime(int maximumSetBufferTime)

Set maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call. If set to zero this feature is turned off.

Parameters:

maximumSetBufferTime - maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call

setNetConnectionIdleFrequency

void setNetConnectionIdleFrequency(int netConnectionIdleFrequency)

Set the server to server idle frequency (milliseconds)

Parameters:

netConnectionIdleFrequency - server to server idle frequency (milliseconds)

setNetConnectionProcessorCount

void setNetConnectionProcessorCount(int netConnectionProcessorCount)

Set net connection processor count. Number of threads used for server to server communication (not finished).

Parameters:

netConnectionProcessorCount - net connection processor count

setPingTimeout

void setPingTimeout(int pingTimeout)

Set ping timeout (millseconds)

Parameters:

pingTimeout - ping timeout (millseconds)

setRTPIdleFrequency

void setRTPIdleFrequency(int rtpIdleFrequency)

Set default RTP idle frequency (milliseconds)

Parameters:

rtpIdleFrequency - RTP default client idle frequency (milliseconds)

setShuttingDown

void setShuttingDown(boolean shuttingDown)

Set VHost shutting down flag

Parameters:

shuttingDown - true if the vhost is shutting down

setStartStarupStreams

void setStartStarupStreams(boolean startStarupStreams)

Set to true to startup startup stream as vhost startup

Parameters:

startStarupStreams - true if the startup streams are to start and vhost startup

setValidationFrequency

void setValidationFrequency(int validationFrequency)

Set time between validation pings (milliseconds)

Parameters:

validationFrequency - time between validation pings (milliseconds)

shutdown

void shutdown()

Shutdown.

shutdownApplication

void shutdownApplication(String appName)

Shutdown an application by name. This will disconnect all clients connected to all child application instances.

Parameters:

appName - application name

startApplicationInstance

boolean startApplicationInstance(String appName)

Start an application instance. The default appInstanceName _definst_ will be used.

Parameters:

appName - application name

Returns:

true is successful

startApplicationInstance

boolean startApplicationInstance(String appName,
                                 String appInstanceName)

Start an application instance.

Parameters:

appName - application name

appInstanceName - app instance name

Returns:

true is successful

startStartupStreams

void startStartupStreams()

Method to start startup streams

stopStartupStreams

void stopStartupStreams()

Method to stop startup streams

suspendAllHostPorts

void suspendAllHostPorts()

Suspend all HostPorts from accepting new connections. Current connections will continue to be serviced

touchApplicationInstance

boolean touchApplicationInstance(String appName)

Start an application instance if it is not already started then touch it so it stays loaded for at least 3 seconds.

Parameters:

appName - application name

Returns:

true is successful

touchApplicationInstance

boolean touchApplicationInstance(String appName,
                                 String appInstanceName)

Start an application instance if it is not already started then touch it so it stays loaded for at least 3 seconds. The default appInstanceName _definst_ will be used.

Parameters:

appName - application name

appInstanceName - app instance name

Returns:

true is successful

unbindAllHostPorts

void unbindAllHostPorts()

Unbind all HostPorts and drop all connections

updateLoggingDuration

void updateLoggingDuration()

Internal: update the internal logging values.

writeVHostConfig

boolean writeVHostConfig(String sName,
                         String data)

Method to write xml config file..