All Classes Namespaces Files Functions Pages
MeetingPoint Class Reference

A MeetingPoint is a server that controls a set of wireless devices. More...

Methods

 Description.Get
 Returns a textual description of the object.
 
 Device.Get
 Returns the device that matches the given device identifier. More...
 
 Device.Identifiers.Get
 Returns the list of device identifiers of the devices connected to the Meeting Point. More...
 
 Device.List.Get
 Returns the list of devices that are connected to the Meeting Point. More...
 
 Device.List.Length.Get
 Returns the number of devices that are connected to the Meeting Point. More...
 
 Devices.Prepare.Async endpoints...
 Prepares all the given Wireless Endpoints. More...
 
 Devices.Prepare endpoints...
 Prepare all the given Wireless Endpoints. More...
 
 Devices.Start endpoints...
 Starts all the given Wireless Endpoints. More...
 
 Parent.Get
 Returns the parent object.
 
 ServiceInfo.Get
 Returns the service information of the Meeting Point daemon. More...
 
 Timestamp.Get
 Returns the current timestamp on the server. More...
 

Class overview

A MeetingPoint is a server that controls a set of wireless devices.

Wireless Endpoints can connect to a Meeting Point by using the ByteBlower Wireless Endpoints App.

Since
2.6.0

Definition at line 17685 of file api.tcl.

Method documentation

MeetingPoint::Device.Get

Returns the device that matches the given device identifier.

Example
1 $meeting_point Device.Get $device_id

Definition at line 17700 of file api.tcl.

MeetingPoint::Device.Identifiers.Get

Returns the list of device identifiers of the devices connected to the Meeting Point.

Example
1 $meeting_point Device.Identifiers.Get

Definition at line 17710 of file api.tcl.

MeetingPoint::Device.List.Get

Returns the list of devices that are connected to the Meeting Point.

Example
1 $meeting_point Device.List.Get

Definition at line 17720 of file api.tcl.

MeetingPoint::Device.List.Length.Get

Returns the number of devices that are connected to the Meeting Point.

Example
1 $meeting_point Device.List.Length.Get

Definition at line 17730 of file api.tcl.

MeetingPoint::Devices.Prepare   endpoints...  

Prepare all the given Wireless Endpoints.

Parameters
endpoints...one or more WirelessEndpoint objects to prepare.
Example

Assume the client is connected (through this object) to a server:

1 $meetingpoint Devices.Prepare $endpoint1 $endpoint2...

Definition at line 17756 of file api.tcl.

MeetingPoint::Devices.Prepare.Async   endpoints...  

Prepares all the given Wireless Endpoints.

After the meeting point is informed about the wish to prepare the endpoints the API directly returns. Call DevicesPrepare to wait until all devices are prepared.

Parameters
endpoints...one or more WirelessEndpoint objects to prepare.
Example

Assume the client is connected (through this object) to a server:

1 $meetingpoint Devices.Prepare.Async $endpoint1 $endpoint2...

Returns:

1432805398000000000 

Definition at line 17744 of file api.tcl.

MeetingPoint::Devices.Start   endpoints...  

Starts all the given Wireless Endpoints.

Parameters
endpoints...one or more WirelessEndpoint objects on which to start the traffic, triggers and HTTPClients
Returns
Timestamp when the devices will start in nanoseconds
Example

Assume the client is connected (through this object) to a server:

1 $meetingpoint Devices.Start $endpoint1 $endpoint2...

Returns:

1432805398000000000 

Definition at line 17770 of file api.tcl.

MeetingPoint::ServiceInfo.Get

Returns the service information of the Meeting Point daemon.

Since
2.6.0
Example
1 $meeting_point ServiceInfo.Get

Returns:

<MeetingPoint.ServiceInfo object> 

Definition at line 17787 of file api.tcl.

MeetingPoint::Timestamp.Get

Returns the current timestamp on the server.

Retrieves the current timestamp of the server in nanoseconds. This can be used to calculate the offset between two servers to compare results.

Returns
Timestamp in nanoseconds
Example

Assume the client is connected (through this object) to a server:

1 $meetingpoint Timestamp.Get

Returns:

1432805398000000000 

Definition at line 17801 of file api.tcl.