Singleton class that is the entry point to start using the ByteBlower API. More...

Methods
	API.Version.Get
	Returns the version of the API. More...

	Description.Get
	Returns a textual description of the object.

	Logging.Console.Level.Get

	Logging.Console.Level.Set

	Logging.File.Enable

	Logging.File.IsEnabled

	Logging.File.Level.Get

	Logging.File.Level.Set

	Logging.File.Name.Get
	Returns the current log file if enabled. More...

	Logging.File.Name.Set filepath
	Enables (or disables) file logging to a specified file name. More...

	Logging.Levels.Get
	Returns a list of the available log levels. More...

	MeetingPoint.Add server port
	Opens a connection to a Meeting Point and adds it to the current API instance. More...

	MeetingPoint.Get
	Returns all Meeting Point connections within this API instance. More...

	Parent.Get
	Returns the parent object.

	Ports.Start ports...
	Starts all traffic streams and application schedules on the specified ByteBlower ports. More...

	Ports.Stop ports...
	Stops all traffic streams and application schedules on the specified ByteBlower ports. More...

	Results.Refresh
	Refreshes multiple result objects. More...

	Schedule.Group.Create
	Create a ScheduleGroup. More...

	Schedule.Group.Get
	Returns all existing ScheduleGroup. More...

	Schedules.Start schedules...
	Starts the specified schedulable objects. More...

	Schedules.Stop schedules...
	Stops the specified schedulable objects. More...

	Server.Add server port
	Opens a connection to a ByteBlower server and adds it to the current API instance. More...

	Server.Get
	Returns all server connections within this API instance. More...

	WirelessEndpoints.Prepare.Async wirelessEndpoints...
	Prepares all the specified Wireless Endpoints in an asynchronious way. More...

	WirelessEndpoints.Prepare wirelessEndpoints...
	Prepares all the specified Wireless Endpoints. More...

	WirelessEndpoints.Start wirelessEndpoints...
	Starts all traffic streams and application schedules on the specified Wireless Endpoints. More...

	WirelessEndpoints.StartAndWait wirelessEndpoints...
	Starts all traffic streams and application schedules on the specified Wireless Endpoints And waits until the devices are started. More...

Static methods
	API.Version.Get
	Returns the version of the API. More...

	Instance.Get
	Creates or returns the ByteBlower API singleton instance. More...

	MeetingPoint.Add server port
	Opens a connection to a Meeting Point and adds it to the current API instance. More...

	MeetingPoint.Get
	Returns all Meeting Point connections within this API instance. More...

	Ports.Start ports...
	Start all traffic streams and application schedules on the specified ByteBlower ports. More...

	Ports.Stop ports...
	Stops all traffic streams and application schedules on the specified ByteBlower ports. More...

	Results.Refresh results...
	Refreshes all results given. More...

	Schedules.Start schedules...
	Starts the specified schedulable objects. More...

	Schedules.Stop schedules...
	Stops the specified schedulable objects. More...

	Server.Add server port
	Opens a connection to a ByteBlower server and adds it to the current API instance. More...

	Server.Get
	Returns all server connections within this API instance. More...

	Tk
	Opens a basic graphical user interface, that provides access to all functionality of this class. More...

Class overview

Singleton class that is the entry point to start using the ByteBlower API.

Typically, this is the first class you will use when writing a ByteBlower test script. Use this class to connect to ByteBlower servers, to start or stop all configured ByteBlower ports across those servers, and to control the logging behavior.

Retrieve the singleton ByteBlower object using the static method Instance.Get.

This class contains some static convenience methods. They are wrappers around the corresponding non-static methods of the singleton object.

Definition at line 18 of file api.tcl.

Method documentation

ByteBlower::API.Version.Get

Returns the version of the API.

Since: 2.6.0

Example

1 [ByteBlower Instance.Get] API.Version.Get

Returns:

2.6.0

Definition at line 30 of file api.tcl.

ByteBlower::API.Version.Get

static

Returns the version of the API.

Since: 2.6.0

Example

1 ByteBlower API.Version.Get

Returns:

2.6.0

Definition at line 471 of file api.tcl.

ByteBlower::Instance.Get

static

Creates or returns the ByteBlower API singleton instance.

This object is the entry point to start working with the ByteBlower Tcl API.

If no ByteBlower instance is created yet, this method creates one and returns the object. If the instance exists already, it is simply returned. Any other static call will implicitly instantiate this singleton object.

Returns: ByteBlower singleton instance.

Example

1 set bb [ ByteBlower Instance.Get ]

Returns:

<ByteBlower object>

Definition at line 489 of file api.tcl.

ByteBlower::Logging.File.Name.Get

Returns the current log file if enabled.

If file logging was successfully configured, the log file path is returned. Otherwise, the empty string is returned.

Returns: Path to the active log file or the empty string if file logging is currently disabled.

Example

1 ByteBlower Logging.File.Name.Get

Returns:

myscript.log

Definition at line 79 of file api.tcl.

ByteBlower::Logging.File.Name.Set			filepath

Enables (or disables) file logging to a specified file name.

By specifying a path name or the empty string, file logging can be enabled or disabled respectively.

If a simple filename is passed, the file will be searched (and created/opened) in the current directory. If a path is specified, the file will be created or opened there. Note that the directory path must already exist, parent directories will not be created automatically.

Bug:: If the logging file cannot be created or opened (due to permissions or a non-existing path), the user will not be notified of this issue, but logging will not be enabled. Retrieve the filename afterwards to know whether file logging is actually enabled: if the empty string is returned, something went wrong.

Parameters

filepath Path to the desired log file or the empty string to disable file logging.

Example

1 ByteBlower Logging.File.Name.Set myscript.log

1 ByteBlower Logging.File.Name.Set /var/log/myscripts/myscript.log

1 ByteBlower Logging.File.Name.Set ""

Definition at line 100 of file api.tcl.

ByteBlower::Logging.Levels.Get

Returns a list of the available log levels.

The available logging levels and their default state are:

DEPRECATED: Logs deprecated calls (default enabled)
ERROR: Logs all errors (default enabled)
WARNING: Logs all errors (default enabled)
INFO: Logs all information messages (default disabled)
DEBUG: Logs all debug information (default disabled)
TRACE: Logs all implementation traces (default disabled)

Returns: List of all available logging level strings.

Example

1 ByteBlower Logging.Levels.Get

Returns:

DEPRECATED ERROR WARNING INFO DEBUG TRACE

Definition at line 114 of file api.tcl.

ByteBlower::MeetingPoint.Add			server port

Opens a connection to a Meeting Point and adds it to the current API instance.

A single client instance may be connected to multiple MeetingPoint servers. This allows to use a set of Meeting point servers as a single system. On the other hand, multiple client instances may be connected to a single (shared) MeetingPoint server and will share its resources. See MeetingPoint for more information.

Since: 2.6.0

Parameters

server	IP address or hostname of the MeetingPoint server to connect.
port	Remote TCP port on which to connect the MeetingPoint server. Should normally never be overridden. Default: `9101`

Returns: A MeetingPoint object that represents the server connection.

Exceptions

ByteBlower.Exception.API.MeetingPointUnreachable	When the MeetingPoint server daemon could not be reached. Typical causes are an incorrect or unreachable DNS name or IP address or a MeetingPoint server daemon that is not running (on purpose or due to a software issue).
<tcl_error>	Relevant network error: When something unexpectedly went wrong with the network connection.
ByteBlower.Exception.InvalidValue.Integer	When the <port> parameter is provided and is no integer.

Example

1 set bb [ ByteBlower Instance.Get ]

2 set server [ $bb MeetingPoint.Add byteblower-1.lab.excentis.com ]

Returns:

<MeetingPoint object>

Definition at line 141 of file api.tcl.

ByteBlower::MeetingPoint.Add			server port

static

Opens a connection to a Meeting Point and adds it to the current API instance.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call MeetingPoint.Add on it.

A single client instance may be connected to multiple MeetingPoint servers. This allows to use a set of Meeting point servers as a single system. On the other hand, multiple client instances may be connected to a single (shared) MeetingPoint server and will share its resources. See MeetingPoint for more information.

Parameters

server	IP address or hostname of the MeetingPoint server to connect.
port	Remote TCP port on which to connect the MeetingPoint server. Should normally never be overridden. Default: `9101`

Returns: A MeetingPoint object that represents the server connection.

Exceptions

ByteBlower.Exception.API.MeetingPointUnreachable	When the MeetingPoint server daemon could not be reached. Typical causes are an incorrect or unreachable DNS name or IP address or a MeetingPoint server daemon that is not running (on purpose or due to a software issue).
<tcl_error>	Relevant network error: When something unexpectedly went wrong with the network connection.
ByteBlower.Exception.InvalidValue.Integer	When the <port> parameter is provided and is no integer.

Example

1 set server [ ByteBlower MeetingPoint.Add byteblower-1.lab.excentis.com ]

Returns:

<MeetingPoint object>

Since: 2.6.0

Definition at line 519 of file api.tcl.

ByteBlower::MeetingPoint.Get

Returns all Meeting Point connections within this API instance.

See MeetingPoint.Add for more information

Since: 2.6.0

Returns: List of MeetingPoint objects created within this API instance. Can be empty

Example

1 set bb [ ByteBlower Instance.Get ]

2 $bb MeetingPoint.Get

Returns:

[ <MeetingPoint object> ... ]

Definition at line 158 of file api.tcl.

ByteBlower::MeetingPoint.Get

static

Returns all Meeting Point connections within this API instance.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call MeetingPoint.Get on it.

See MeetingPoint.Add for more information

Since: 2.6.0

Returns: List of MeetingPoint objects created within this API instance. Can be empty

Example

1 ByteBlower MeetingPoint.Get

Returns:

[ <MeetingPoint object> ... ]

Definition at line 539 of file api.tcl.

ByteBlower::Ports.Start			ports...

Starts all traffic streams and application schedules on the specified ByteBlower ports.

More specifically, for each traffic stream and schedulable object on the specified ports, the configured time to wait kicks off and when this time has passed the corresponding action is performed.

Typical actions include starting a traffic stream or sending out a multicast join message or HTTP request. See Tx.Stream and Schedules.Start for more information.

Streams or schedulable objects that are already scheduled and streams that are already active are ignored. Schedulable objects that are already stopped are scheduled again. See Schedules.Start for more information.

If a port does not contain any streams or schedules, nothing happens for that port.

Parameters

ports... Zero, one or more ByteBlowerPort objects on which to start traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <ports> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <ports> is no ByteBlowerPort object.

Example

1 $bb Ports.Start $port1 $port2 ...

Definition at line 187 of file api.tcl.

ByteBlower::Ports.Start			ports...

static

Start all traffic streams and application schedules on the specified ByteBlower ports.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Ports.Start on it.

See ByteBlower::Ports.Start for more information.

Parameters

ports... Zero, one or more ByteBlowerPort objects on which to start traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <ports> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <ports> is no ByteBlowerPort object.

Example

1 ByteBlower Ports.Start $port1 $port2 ...

Definition at line 561 of file api.tcl.

ByteBlower::Ports.Stop			ports...

Stops all traffic streams and application schedules on the specified ByteBlower ports.

More specifically, all traffic streams and schedulable objects that are currently scheduled are cancelled and all active traffic streams are stopped. Since schedulable objects are only active for an instant, aborting these is not possible.

For more information about schedulable objects, see Schedules.Start.

Streams and schedules that are not running are ignored. This may be because they have not yet started or because they are already finished or stopped.

If a port does not contain any streams or schedules, nothing happens for that port.

Parameters

ports... Zero, one or more ByteBlowerPort objects on which to abort traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <ports> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <ports> is no ByteBlowerPort object.

Example

1 $bb Ports.Stop $port1 $port2 ...

Definition at line 211 of file api.tcl.

ByteBlower::Ports.Stop			ports...

static

Stops all traffic streams and application schedules on the specified ByteBlower ports.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Ports.Stop on it.

See ByteBlower::Ports.Stop for more information.

Parameters

ports... Zero, one or more ByteBlowerPort objects on which to abort traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <ports> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <ports> is no ByteBlowerPort object.

Example

1 ByteBlower Ports.Stop $port1 $port2 ...

Definition at line 583 of file api.tcl.

ByteBlower::Results.Refresh

Refreshes multiple result objects.

Sometimes you want to refresh a lot of results-object at the same time. You can refresh all those object in one API call. The results will be batched per server and then refreshed.

Returns: nothing

Since: API 2.2

Example

 set byteblower [ ByteBlower Instance.Get ]  
  set streamresult1 [ $stream1 Result.Get ]  
  set streamresult2 [ $stream2 Result.Get ]  
  set triggerresult1 [ $trigger1 Result.Get ]  
  set triggerresult2 [ $trigger2 Result.Get ]  
  $byteblower Results.Refresh $streamresult1 $streamresult2 $triggerresult1 $triggerresult2

Example

 Using a list with all the result-objects you want to refresh. 
 
 set results [ list ]  
  lappend results [ $stream1 Result.Get ]  
  lappend results [ $stream2 Result.Get ]  
  lappend results [ $trigger1 Result.Get ]  
  lappend results [ $trigger2 Result.Get ]  
  lappend results [ $trigger3 Result.History.Get ]  
  set byteblower [ ByteBlower Instance.Get ]  
  eval { $byteBlower Results.Refresh } $results

Definition at line 246 of file api.tcl.

ByteBlower::Results.Refresh			results...

static

Refreshes all results given.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Results.Refresh on it.

See ByteBlower::Results.Refresh for more information.

Parameters

results... Zero, one or more result objects on which to call the Refresh function

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <results> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <results> is not refreshable.

Example

1 ByteBlower Results.Refresh $result1 $result2 ...

Definition at line 605 of file api.tcl.

ByteBlower::Schedule.Group.Create

Create a ScheduleGroup.

Returns: ScheduleGroup

Example

1 $bb Schedule.Group.Create

Returns:

<ScheduleGroup object>

Definition at line 258 of file api.tcl.

ByteBlower::Schedule.Group.Get

Returns all existing ScheduleGroup.

Returns: List of ScheduleGroup objects. Can be empty.

Example

1 $bb Schedule.Group.Create

Returns:

[ <ScheduleGroup object> ... ]

Definition at line 270 of file api.tcl.

ByteBlower::Schedules.Start			schedules...

Starts the specified schedulable objects.

More specifically, all specified schedulable objects have their time to wait period kick off simultaneously and when this time has passed the corresponding action is performed.

Typical actions include sending out a multicast join message or an HTTP request. All schedulable objects are listed below.

Schedulable objects that are already scheduled are ignored. Schedulable objects that are already finished or cancelled are scheduled again.

While re-scheduling them will always succeed (and this method will return without error), executing them multiple times may result in error states in other places. For example, a Layer5.Http.Client can only manage one HTTP session and will refuse to send out a second HTTP request.

Different kinds of schedulable objects exist throughout the API. They are returned by methods such as Layer4.Igmpv1MemberSession::Schedule.Add.

After creating and configuring such schedules, they can be scheduled by either passing them to this method or by passing the port(s) on which they were created to Ports.Start.

The following schedulable object types are available in the API:

These schedules will become available as soon as their respective protocols are implemented:

Bug:: HTTP requests are not yet available as a schedulable object and cannot be used with this method.

Parameters

schedules... Zero, one or more schedulable objects to start.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <schedules> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <schedules> is no schedulable object.

Example

1 $bb Schedules.Start $sched_obj1 $sched_obj2

Definition at line 307 of file api.tcl.

ByteBlower::Schedules.Start			schedules...

static

Starts the specified schedulable objects.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Schedules.Start on it.

See ByteBlower::Schedules.Start for more information.

Parameters

schedules... Zero, one or more schedulable objects to start.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <schedules> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <schedules> is no schedulable object.

Example

1 ByteBlower Schedules.Start $sched_obj1 $sched_obj2 ...

Definition at line 627 of file api.tcl.

ByteBlower::Schedules.Stop			schedules...

Stops the specified schedulable objects.

More specifically, all specified schedulable objects that are currently scheduled are cancelled. Schedulable objects are only active for an instant, so actually aborting them is not possible.

For more information about schedulable objects, see Schedules.Start.

Schedules that are not running are ignored. This may be because they have not yet started or because they are already finished or cancelled.

Parameters

schedules... Zero, one or more schedulable objects to abort.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <schedules> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <schedules> is no schedulable object.

Example

1 $bb Schedules.Stop $sched_obj1 $sched_obj2 ...

Definition at line 329 of file api.tcl.

ByteBlower::Schedules.Stop			schedules...

static

Stops the specified schedulable objects.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Schedules.Stop on it.

See ByteBlower::Schedules.Stop for more information.

Parameters

schedules... Zero, one or more schedulable objects to abort.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <schedules> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <schedules> is no schedulable object.

Example

1 ByteBlower Schedules.Stop $sched_obj1 $sched_obj2 ...

Definition at line 649 of file api.tcl.

ByteBlower::Server.Add			server port

Opens a connection to a ByteBlower server and adds it to the current API instance.

A single client instance may be connected to multiple ByteBlower servers. This allows to use a set of ByteBlower servers as a single system. On the other hand, multiple client instances may be connected to a single (shared) ByteBlower server and will share its resources. See ByteBlowerServer for more information.

Parameters

server	IP address or hostname of the ByteBlower server to connect.
port	Remote TCP port on which to connect the ByteBlower server. Should normally never be overridden. Default: `9002`

Returns: A ByteBlowerServer object that represents the server connection.

Exceptions

ByteBlower.Exception.API.ByteBlowerServerUnreachable	When the ByteBlower server daemon could not be reached. Typical causes are an incorrect or unreachable DNS name or IP address or a ByteBlower server daemon that is not running (on purpose or due to a software issue).
ByteBlower.Exception.API.ByteBlowerServerIncompatible	When the ByteBlower server daemon is running an incompatible version.
<tcl_error>	Relevant network error: When something unexpectedly went wrong with the network connection.
ByteBlower.Exception.InvalidValue.Integer	When the <port> parameter is provided and is no integer.

Example

1 set bb [ ByteBlower Instance.Get ]

1 set server [ $bb Server.Add byteblower-1.lab.excentis.com ]

Returns:

<ByteBlowerServer object>

Definition at line 355 of file api.tcl.

ByteBlower::Server.Add			server port

static

Opens a connection to a ByteBlower server and adds it to the current API instance.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Server.Add on it.

See ByteBlower::Server.Add for more information.

Parameters

server	IP address or hostname of the ByteBlower server to connect.
port	Remote TCP port on which to connect the ByteBlower server. Should normally never be overridden. Default: `9002`

Returns: A ByteBlowerServer object that represents the server connection.

Exceptions

ByteBlower.Exception.API.ByteBlowerServerUnreachable	When the ByteBlower server daemon could not be reached. Typical causes are an incorrect or unreachable DNS name or IP address or a ByteBlower server daemon that is not running (on purpose or due to a software issue).
ByteBlower.Exception.API.ByteBlowerServerIncompatible	When the ByteBlower server daemon is running an incompatible version.
<tcl_error>	Relevant network error: When something unexpectedly went wrong with the network connection.
ByteBlower.Exception.InvalidValue.Integer	When the <port> parameter is provided and is no integer.

Example

1 set server [ ByteBlower Server.Add byteblower-1.lab.excentis.com ]

Returns:

<ByteBlowerServer object>

Definition at line 679 of file api.tcl.

ByteBlower::Server.Get

Returns all server connections within this API instance.

See Server.Add for more information.

Returns: List of ByteBlowerServer objects created within this API instance. Can be empty.

Example

1 set bb [ ByteBlower Instance.Get ]

1 $bb Server.Get

Returns:

[ <ByteBlowerServer object> ... ]

Definition at line 369 of file api.tcl.

ByteBlower::Server.Get

static

Returns all server connections within this API instance.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Server.Get on it.

See ByteBlower::Server.Get for more information.

Returns: List of ByteBlowerServer objects representing server connections initiated within this API instance. Can be empty.

Example

1 ByteBlower Server.Get

Returns:

[ <ByteBlowerServer object> ... ]

Definition at line 697 of file api.tcl.

ByteBlower::Tk

static

Opens a basic graphical user interface, that provides access to all functionality of this class.

Deprecated:: This method is marked as deprecated, because it should be accessed on the singleton instance in a non-static way. Retrieve the singleton with Instance.Get and call Tk on it.

Bug:: Throws arcane Tcl error instead of a clean exception when the TK package is not available.

Exceptions

<tcl_error> When the TK package is not available. Typically occurs when the API runs on a server without a graphical environment

Example

Assume a graphical environment is available on the client (i.e. the client is a desktop).

1 ByteBlower Tk

Definition at line 718 of file api.tcl.

ByteBlower::WirelessEndpoints.Prepare			wirelessEndpoints...

Prepares all the specified Wireless Endpoints.

If a wireless endpoint does not contain any streams or schedules, nothing happens for that Wireless Endpoint.

Parameters

wirelessEndpoints... Zero, one or more ByteBlowerPort objects on which to start traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <wirelessEndpoints> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <wirelessEndpoints> is no WirelessEndpoint object.
ByteBlower.Exception.TechnicalError	When the items in <wirelessEndpoints> are spread across multiple MeetingPoints.

Example

1 $bb WirelessEndpoints.Prepare $endpoint1 $endpoint2...

Definition at line 409 of file api.tcl.

ByteBlower::WirelessEndpoints.Prepare.Async			wirelessEndpoints...

Prepares all the specified Wireless Endpoints in an asynchronious way.

If a wireless endpoint does not contain any streams or schedules, nothing happens for that Wireless Endpoint.

Parameters

wirelessEndpoints... Zero, one or more ByteBlowerPort objects on which to start traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <wirelessEndpoints> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <wirelessEndpoints> is no WirelessEndpoint object.
ByteBlower.Exception.TechnicalError	When the items in <wirelessEndpoints> are spread across multiple MeetingPoints.

Example

1 $bb WirelessEndpoints.Prepare.Async $endpoint1 $endpoint2...

Definition at line 389 of file api.tcl.

ByteBlower::WirelessEndpoints.Start			wirelessEndpoints...

Starts all traffic streams and application schedules on the specified Wireless Endpoints.

More specifically, for each traffic stream and trigger object on the specified endpoints, the configured time to wait kicks off and when this time has passed the corresponding action is performed.

Typical actions include starting a traffic stream or HTTP request. See Tx.Stream.Mobile for more information.

If a wireless endpoint does not contain any streams or schedules, nothing happens for that Wireless Endpoint.

Parameters

wirelessEndpoints... Zero, one or more ByteBlowerPort objects on which to start traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <wirelessEndpoints> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <wirelessEndpoints> is no WirelessEndpoint object.
ByteBlower.Exception.TechnicalError	When the items in <wirelessEndpoints> are spread across multiple MeetingPoints.

Example

1 $bb WirelessEndpoints.Start $endpoint1 $endpoint2...

Definition at line 433 of file api.tcl.

ByteBlower::WirelessEndpoints.StartAndWait			wirelessEndpoints...

Starts all traffic streams and application schedules on the specified Wireless Endpoints And waits until the devices are started.

More specifically, for each traffic stream and trigger object on the specified endpoints, the configured time to wait kicks off and when this time has passed the corresponding action is performed.

Typical actions include starting a traffic stream or HTTP request. See Tx.Stream.Mobile for more information.

If a wireless endpoint does not contain any streams or schedules, nothing happens for that Wireless Endpoint.

Parameters

wirelessEndpoints... Zero, one or more ByteBlowerPort objects on which to start traffic streams and application schedules.

Exceptions

ByteBlower.Exception.InvalidValue.NotAnObject	When one of the items in <wirelessEndpoints> is no object identifier.
ByteBlower.Exception.InvalidValue.ObjectType	When one of the items in <wirelessEndpoints> is no WirelessEndpoint object.
ByteBlower.Exception.TechnicalError	When the items in <wirelessEndpoints> are spread across multiple MeetingPoints.

Example

1 $bb WirelessEndpoints.StartAndWait $endpoint1 $endpoint2...

Definition at line 457 of file api.tcl.

Methods

Static methods

Class overview

Method documentation