Cell Broadcast

Data Structures
struct	telux::tel::CellBroadcastFilter
struct	telux::tel::Point
class	telux::tel::Polygon
class	telux::tel::Circle
class	telux::tel::Geometry
class	telux::tel::WarningAreaInfo
class	telux::tel::EtwsInfo
class	telux::tel::CmasInfo
class	telux::tel::CellBroadcastMessage
	Cell Broadcast message. More...
class	telux::tel::ICellBroadcastManager
	CellBroadcastManager class is primary interface to configure and activate emergency broadcast messages and receive broadcast messages. More...
class	telux::tel::ICellBroadcastListener
	A listener class which monitors cell broadcast messages. More...

Typedefs
using	telux::tel::RequestFiltersResponseCallback = std::function< void(std::vector< CellBroadcastFilter > filters, telux::common::ErrorCode error)>
using	telux::tel::RequestActivationStatusResponseCallback = std::function< void(bool isActivated, telux::common::ErrorCode error)>

Enumerations
enum	telux::tel::GeographicalScope { telux::tel::GeographicalScope::CELL_WIDE_IMMEDIATE = 0, telux::tel::GeographicalScope::PLMN_WIDE = 1, telux::tel::GeographicalScope::LA_WIDE = 2, telux::tel::GeographicalScope::CELL_WIDE = 3 }
enum	telux::tel::MessagePriority { telux::tel::MessagePriority::UNKNOWN = -1, telux::tel::MessagePriority::NORMAL = 0, telux::tel::MessagePriority::EMERGENCY = 1 }
enum	telux::tel::MessageType { telux::tel::MessageType::UNKNOWN = -1, telux::tel::MessageType::ETWS = 0, telux::tel::MessageType::CMAS = 1 }
enum	telux::tel::EtwsWarningType {   telux::tel::EtwsWarningType::UNKNOWN = -1, telux::tel::EtwsWarningType::EARTHQUAKE = 0, telux::tel::EtwsWarningType::TSUNAMI = 1, telux::tel::EtwsWarningType::EARTHQUAKE_AND_TSUNAMI = 2,   telux::tel::EtwsWarningType::TEST_MESSAGE = 3, telux::tel::EtwsWarningType::OTHER_EMERGENCY = 4 }
enum	telux::tel::CmasMessageClass {   telux::tel::CmasMessageClass::UNKNOWN = -1, telux::tel::CmasMessageClass::PRESIDENTIAL_LEVEL_ALERT = 0, telux::tel::CmasMessageClass::EXTREME_THREAT = 1, telux::tel::CmasMessageClass::SEVERE_THREAT = 2,   telux::tel::CmasMessageClass::CHILD_ABDUCTION_EMERGENCY = 3, telux::tel::CmasMessageClass::REQUIRED_MONTHLY_TEST = 4, telux::tel::CmasMessageClass::CMAS_EXERCISE = 5, telux::tel::CmasMessageClass::OPERATOR_DEFINED_USE = 6 }
enum	telux::tel::CmasSeverity { telux::tel::CmasSeverity::UNKNOWN = -1, telux::tel::CmasSeverity::EXTREME = 0, telux::tel::CmasSeverity::SEVERE = 1 }
enum	telux::tel::CmasUrgency { telux::tel::CmasUrgency::UNKNOWN = -1, telux::tel::CmasUrgency::IMMEDIATE = 0, telux::tel::CmasUrgency::EXPECTED = 1 }
enum	telux::tel::CmasCertainty { telux::tel::CmasCertainty::UNKNOWN = -1, telux::tel::CmasCertainty::OBSERVED = 0, telux::tel::CmasCertainty::LIKELY = 1 }
enum	telux::tel::GeometryType { telux::tel::GeometryType::UNKNOWN = -1, telux::tel::GeometryType::POLYGON = 0, telux::tel::GeometryType::CIRCLE = 1 }

Detailed Description

This section contains APIs related to configure, activate and receive 3GPP ETWS/CMAS cell broadcast messages.

---

Data Structure Documentation

struct telux::tel::CellBroadcastFilter

Defines cellbroadcast message filter. Refer spec 3GPP TS 23.041 9.4.1.2.2 for message identifier. Eg: If user want to receive from 0x1112 to 0x1116 then, startMessageId is 0x1112 and endMessageId is 0x1116. If user want to receive only 0x1112, then both startMessageId and endMessageId is 0x1112.

Data Fields
int	startMessageId	Intended to receive start from which MessageType
int	endMessageId	Intended to receive upto which MessageType

struct telux::tel::Point

Point represented by latitude and longitude.

Data Fields
double	latitude
double	longitude

class telux::tel::Polygon

This class represents a simple polygon with different points.

Public Member Functions
	Polygon (std::vector< Point > vertices)
std::vector< Point >	getVertices ()

Constructor & Destructor Documentation

telux::tel::Polygon::Polygon

(

std::vector< Point >

vertices

)

Polygon constructor.

Parameters

[in]

vertices

List of telux::tel::Point

Member Function Documentation

std::vector<Point> telux::tel::Polygon::getVertices

(

)

Get vertices of polygon.

Returns

List of telux::tel::Point.

class telux::tel::Circle

This class represents a geometry represented as simple circle.

Public Member Functions
	Circle (Point center, double radius)
Point	getCenter ()
double	getRadius ()

Constructor & Destructor Documentation

telux::tel::Circle::Circle	(	Point	center,
		double	radius
	)

Circle constructor.

Parameters

[in]	center	Center of circle represented by telux::tel::Point
[in]	radius	Radius of circle in meters

Member Function Documentation

Point telux::tel::Circle::getCenter

(

)

Get center point of circle.

Returns

Center of circle.

double telux::tel::Circle::getRadius

(

)

Get radius of circle.

Returns

Radius of circle.

class telux::tel::Geometry

This class represents warning area geometry to perform geofencing on alert.

Public Member Functions
	Geometry (std::shared_ptr< Polygon > polygon)
	Geometry (std::shared_ptr< Circle > circle)
GeometryType	getType () const
std::shared_ptr< Polygon >	getPolygon () const
std::shared_ptr< Circle >	getCircle () const

Constructor & Destructor Documentation

telux::tel::Geometry::Geometry

(

std::shared_ptr< Polygon >

polygon

)

Geometry constructor.

Parameters

[in]

polygon

Polygon

telux::tel::Geometry::Geometry

(

std::shared_ptr< Circle >

circle

)

Geometry constructor.

Parameters

[in]

circle

Circle

Member Function Documentation

GeometryType telux::tel::Geometry::getType

(

)

const

Get the geometry type.

Returns

GeometryType.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

std::shared_ptr<Polygon> telux::tel::Geometry::getPolygon

(

)

const

Get polygon goemetry as warning area to perform geofencing. This method should be called only if geometry type returned by getType() API is GeometryType::POLYGON

Returns

Polygon geometry object.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

std::shared_ptr<Circle> telux::tel::Geometry::getCircle

(

)

const

Get circle goemetry as warning area to perform geofencing. This method should be called only if geometry type returned by getType() API is GeometryType::CIRCLE

Returns

Circle geometry object.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

class telux::tel::WarningAreaInfo

This class represents warning area information for alert.

Public Member Functions
	WarningAreaInfo (int maxWaitTime, std::vector< Geometry > geometries)
int	getGeoFenceMaxWaitTime ()
std::vector< Geometry >	getGeometries ()

Constructor & Destructor Documentation

telux::tel::WarningAreaInfo::WarningAreaInfo	(	int	maxWaitTime,
		std::vector< Geometry >	geometries
	)

Warning Area Information constructor.

Parameters

[in]	maxWaitTime	Maximum wait time allowed to determine position for alert Range is 0 to 255 where 0 means Zero wait time, 1 - 254 is Geo-Fencing Maximum Wait Time in seconds and 255 means use device default wait time.
[in]	geometries	Geometries to perform geofencing on alert

Member Function Documentation

int telux::tel::WarningAreaInfo::getGeoFenceMaxWaitTime

(

)

Get maximum wait time allowed to determine position for alert.

Returns

Maximum wait time for alert in seconds.

std::vector<Geometry> telux::tel::WarningAreaInfo::getGeometries

(

)

Get geometries to perform geofencing on alert.

Returns

List of telux::tel::Geometry.

class telux::tel::EtwsInfo

Contains information elements for a GSM/UMTS/E-UTRAN/NG-RAN ETWS warning notification. Supported values for each element are defined in 3GPP TS 23.041.

Public Member Functions
	EtwsInfo (GeographicalScope geographicalScope, int msgId, int serialNumber, std::string languageCode, std::string messageText, MessagePriority priority, EtwsWarningType warningType, bool emergencyUserAlert, bool activatePopup, bool primary, std::vector< uint8_t > warningSecurityInformation)
GeographicalScope	getGeographicalScope () const
int	getMessageId () const
int	getSerialNumber () const
std::string	getLanguageCode () const
std::string	getMessageBody () const
MessagePriority	getPriority () const
int	getMessageCode () const
int	getUpdateNumber () const
EtwsWarningType	getEtwsWarningType ()
bool	isEmergencyUserAlert ()
bool	isPopupAlert ()
bool	isPrimary ()
std::vector< uint8_t >	getWarningSecurityInformation ()

Constructor & Destructor Documentation

telux::tel::EtwsInfo::EtwsInfo	(	GeographicalScope	geographicalScope,
		int	msgId,
		int	serialNumber,
		std::string	languageCode,
		std::string	messageText,
		MessagePriority	priority,
		EtwsWarningType	warningType,
		bool	emergencyUserAlert,
		bool	activatePopup,
		bool	primary,
		std::vector< uint8_t >	warningSecurityInformation
	)

EtwsInfo constructor.

Parameters

[in]	geographicalScope	GeographicalScope
[in]	msgId	Unique message identifier
[in]	serialNumber	Serial number for message
[in]	languageCode	ISO-639-1 language code for message
[in]	messageText	Message text
[in]	priority	MessagePriority
[in]	warningType	EtwsWarningType
[in]	emergencyUserAlert	If true message is emergency user alert otherwise not
[in]	activatePopup	If true message message activate popup flag is set, otherwise popup flag is false.
[in]	primary	If true ETWS message is primary notification otherwise not
[in]	warningSecurityInformation	Buffer containing security information about ETWS primary notification such as timestamp and digital signature

Member Function Documentation

GeographicalScope telux::tel::EtwsInfo::getGeographicalScope

(

)

const

Get the geographicalScope of cellbroadcast message.

Returns

GeographicalScope.

int telux::tel::EtwsInfo::getMessageId

(

)

const

Get cellbroadcast message identifier. The message identifier identifies the type of the cell broadcast message defined in spec 3GPP TS 23.041 9.4.1.2.2

Returns

Message identifier.

int telux::tel::EtwsInfo::getSerialNumber

(

)

const

Get the serial number of broadcast (geographical scope + message code + update number for GSM/UMTS).

Returns

int containing cellbroadcast serial number.

std::string telux::tel::EtwsInfo::getLanguageCode

(

)

const

Get the ISO-639-1 language code for cell broadcast message, or empty string if unspecified. This is not applicable for ETWS primary notification.

Returns

Language code

std::string telux::tel::EtwsInfo::getMessageBody

(

)

const

Get the body of cell broadcast message, or empty string if no body available. For ETWS primary notification based on message identifier pre cannned message will be sent.

Returns

body or empty string

MessagePriority telux::tel::EtwsInfo::getPriority

(

)

const

Get the priority for the cell broadcast message.

Returns

MessagePriority.

int telux::tel::EtwsInfo::getMessageCode

(

)

const

Get the cellbroadcast message code.

Returns

int containing cellbroadcast message code.

int telux::tel::EtwsInfo::getUpdateNumber

(

)

const

Get the cellbroadcast message update number.

Returns

int containing cellbroadcast message's update number.

EtwsWarningType telux::tel::EtwsInfo::getEtwsWarningType

(

)

Get ETWS warning type.

Returns

EtwsWarningType.

bool telux::tel::EtwsInfo::isEmergencyUserAlert

(

)

Returns the ETWS emergency user alert flag.

Returns

true to notify terminal to activate emergency user alert or false otherwise

bool telux::tel::EtwsInfo::isPopupAlert

(

)

Returns the ETWS activate popup flag.

Returns

true to notify terminal to activate display popup or false otherwise

bool telux::tel::EtwsInfo::isPrimary

(

)

Returns the ETWS format flag. This flag determine whether ETWS message is primary notification or not.

Returns

true if the message is primary message, otherwise secondary message

std::vector<uint8_t> telux::tel::EtwsInfo::getWarningSecurityInformation

(

)

Returns security information about ETWS primary notification such as timestamp and digital signature(applicable only for GSM).

Returns

byte buffer

class telux::tel::CmasInfo

Contains information elements for a GSM/UMTS/E-UTRAN/NG-RAN CMAS warning notification. Supported values for each element are defined in 3GPP TS 23.041.

Public Member Functions
	CmasInfo (GeographicalScope geographicalScope, int msgId, int serialNumber, std::string languageCode, std::string messageText, MessagePriority priority, CmasMessageClass messageClass, CmasSeverity severity, CmasUrgency urgency, CmasCertainty certainty, std::shared_ptr< WarningAreaInfo > warningAreaInfo)
GeographicalScope	getGeographicalScope () const
int	getMessageId () const
int	getSerialNumber () const
std::string	getLanguageCode () const
std::string	getMessageBody () const
MessagePriority	getPriority () const
int	getMessageCode () const
int	getUpdateNumber () const
CmasMessageClass	getMessageClass ()
CmasSeverity	getSeverity ()
CmasUrgency	getUrgency ()
CmasCertainty	getCertainty ()
std::shared_ptr< WarningAreaInfo >	getWarningAreaInfo ()

Constructor & Destructor Documentation

telux::tel::CmasInfo::CmasInfo	(	GeographicalScope	geographicalScope,
		int	msgId,
		int	serialNumber,
		std::string	languageCode,
		std::string	messageText,
		MessagePriority	priority,
		CmasMessageClass	messageClass,
		CmasSeverity	severity,
		CmasUrgency	urgency,
		CmasCertainty	certainty,
		std::shared_ptr< WarningAreaInfo >	warningAreaInfo
	)

CmasInfo constructor.

Parameters

[in]	geographicalScope	GeographicalScope
[in]	msgId	Unique message identifier
[in]	serialNumber	Serial number for message
[in]	languageCode	ISO-639-1 language code for message
[in]	messageText	Message text
[in]	priority	MessagePriority
[in]	messageClass	CmasMessageClass
[in]	severity	CmasSeverity
[in]	urgency	CmasUrgency
[in]	certainty	CmasCertainty

Member Function Documentation

GeographicalScope telux::tel::CmasInfo::getGeographicalScope

(

)

const

Get the geographicalScope of cellbroadcast message.

Returns

GeographicalScope.

int telux::tel::CmasInfo::getMessageId

(

)

const

Get cellbroadcast message identifier. The message identifier identifies the type of the cell broadcast message defined in spec 3GPP TS 23.041 9.4.1.2.2

Returns

Message identifier.

int telux::tel::CmasInfo::getSerialNumber

(

)

const

Get the serial number of broadcast (geographical scope + message code + update number for GSM/UMTS).

Returns

int containing cellbroadcast serial number.

std::string telux::tel::CmasInfo::getLanguageCode

(

)

const

Get the ISO-639-1 language code for cell broadcast message, or empty string if unspecified. This is not applicable for ETWS primary notification.

Returns

Language code

std::string telux::tel::CmasInfo::getMessageBody

(

)

const

Get the body of cell broadcast message, or empty string if no body available. For ETWS primary notification based on message identifier pre cannned message will be sent.

Returns

body or empty string

MessagePriority telux::tel::CmasInfo::getPriority

(

)

const

Get the priority for the cell broadcast message.

Returns

MessagePriority.

int telux::tel::CmasInfo::getMessageCode

(

)

const

Get the cellbroadcast message code.

Returns

int containing cellbroadcast message code.

int telux::tel::CmasInfo::getUpdateNumber

(

)

const

Get the cellbroadcast message update number.

Returns

int containing cellbroadcast message's update number.

CmasMessageClass telux::tel::CmasInfo::getMessageClass

(

)

Get CMAS message class.

Returns

CmasMessageClass.

CmasSeverity telux::tel::CmasInfo::getSeverity

(

)

Get CMAS message severity.

Returns

CmasSeverity.

CmasUrgency telux::tel::CmasInfo::getUrgency

(

)

Get CMAS message urgency.

Returns

CmasUrgency.

CmasCertainty telux::tel::CmasInfo::getCertainty

(

)

Get CMAS message certainty.

Returns

CmasCertainty.

std::shared_ptr<WarningAreaInfo> telux::tel::CmasInfo::getWarningAreaInfo

(

)

Returns warning area information for alert. This is applicable for LTE and NR5G

Returns

pointer to WarningAreaInfo or null if there is no warning area information available.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

class telux::tel::CellBroadcastMessage

Cell Broadcast message.

Public Member Functions
	CellBroadcastMessage (std::shared_ptr< EtwsInfo > etwsInfo)
	CellBroadcastMessage (std::shared_ptr< CmasInfo > cmasInfo)
MessageType	getMessageType () const
std::shared_ptr< EtwsInfo >	getEtwsInfo () const
std::shared_ptr< CmasInfo >	getCmasInfo () const

Constructor & Destructor Documentation

telux::tel::CellBroadcastMessage::CellBroadcastMessage

(

std::shared_ptr< EtwsInfo >

etwsInfo

)

CellBroadcastMessage constructor.

Parameters

[in]

etwsInfo

EtwsInfo

telux::tel::CellBroadcastMessage::CellBroadcastMessage

(

std::shared_ptr< CmasInfo >

cmasInfo

)

CellBroadcastMessage constructor.

Parameters

[in]

cmasInfo

CmasInfo

Member Function Documentation

MessageType telux::tel::CellBroadcastMessage::getMessageType

(

)

const

Get the cellbroadcast message type.

Returns

MessageType.

std::shared_ptr<EtwsInfo> telux::tel::CellBroadcastMessage::getEtwsInfo

(

)

const

Get ETWS warning notification containing information about the ETWS warning type, the emergency user alert flag and the popup flag. This method should be called only if message type returned by getMessageType() API is MessageType::ETWS

Returns

pointer to EtwsInfo or null if this is not an ETWS warning notification

std::shared_ptr<CmasInfo> telux::tel::CellBroadcastMessage::getCmasInfo

(

)

const

Get CMAS warning notification containing information about the CMAS message class, severity, urgency and certainty.This method should be called only if message type returned by getMessageType() API is MessageType::CMAS

Returns

pointer to CmasInfo or null if this is not a CMAS warning notification

class telux::tel::ICellBroadcastManager

CellBroadcastManager class is primary interface to configure and activate emergency broadcast messages and receive broadcast messages.

Public Member Functions
virtual bool	isSubsystemReady ()=0
virtual std::future< bool >	onSubsystemReady ()=0
virtual SlotId	getSlotId ()=0
virtual telux::common::Status	updateMessageFilters (std::vector< CellBroadcastFilter > filters, telux::common::ResponseCallback callback=nullptr)=0
virtual telux::common::Status	requestMessageFilters (RequestFiltersResponseCallback callback)=0
virtual telux::common::Status	setActivationStatus (bool activate, telux::common::ResponseCallback callback=nullptr)=0
virtual telux::common::Status	requestActivationStatus (RequestActivationStatusResponseCallback callback)=0
virtual telux::common::Status	registerListener (std::weak_ptr< ICellBroadcastListener > listener)=0
virtual telux::common::Status	deregisterListener (std::weak_ptr< ICellBroadcastListener > listener)=0
virtual	~ICellBroadcastManager ()

Constructor & Destructor Documentation

virtual telux::tel::ICellBroadcastManager::~ICellBroadcastManager ( )

virtual

Member Function Documentation

virtual bool telux::tel::ICellBroadcastManager::isSubsystemReady ( )

pure virtual

Checks the status of network subsystem and returns the result.

Returns

True if network subsystem is ready for service otherwise false.

virtual std::future<bool> telux::tel::ICellBroadcastManager::onSubsystemReady ( )

pure virtual

Wait for network subsystem to be ready.

Returns

A future that caller can wait on to be notified when network subsystem is ready.

virtual SlotId telux::tel::ICellBroadcastManager::getSlotId ( )

pure virtual

Get associated slot for this CellBroadcastManager.

Returns

SlotId

virtual telux::common::Status telux::tel::ICellBroadcastManager::updateMessageFilters ( std::vector< CellBroadcastFilter >  filters, telux::common::ResponseCallback  callback = nullptr  )

pure virtual

Configures the broadcast messages to be received.

Parameters

[in]	filters	List of filtered broadcast message identifiers.
[in]	callback	Optional callback to get the response of set cell broadcast filters.

Returns

Status of updateMessageIdFilters i.e. success or suitable error code.

virtual telux::common::Status telux::tel::ICellBroadcastManager::requestMessageFilters ( RequestFiltersResponseCallback  callback )

pure virtual

Retrieve configured message filters for which broadcast messages will be received.

Parameters

[in]

callback

Callback to get the response of get cell broadcast filters.

Returns

Status of requestMessageIdFilters i.e. success or suitable error code.

virtual telux::common::Status telux::tel::ICellBroadcastManager::setActivationStatus ( bool  activate, telux::common::ResponseCallback  callback = nullptr  )

pure virtual

Allows activation and deactivation of configured broadcast messages.

Parameters

[in]	activate	Activate/deactivate broadcast messages.
[in]	callback	Optional callback pointer to get the response.

Returns

Status of setActivationStatus i.e. success or suitable error code.

virtual telux::common::Status telux::tel::ICellBroadcastManager::requestActivationStatus ( RequestActivationStatusResponseCallback  callback )

pure virtual

Get activation status for configured broadcast messages.

Parameters

[in]

callback

Callback pointer to get the response.

Returns

Status of requestActivationStatus i.e. success or suitable error code.

virtual telux::common::Status telux::tel::ICellBroadcastManager::registerListener ( std::weak_ptr< ICellBroadcastListener >  listener )

pure virtual

Register a listener for cell broadcast messages.

Parameters

[in]

listener

Pointer to ICellBroadcastListener object which receives broadcast message.

Returns

Status of registerListener i.e. success or suitable error code.

virtual telux::common::Status telux::tel::ICellBroadcastManager::deregisterListener ( std::weak_ptr< ICellBroadcastListener >  listener )

pure virtual

De-register the listener.

Parameters

[in]

listener

Listener to be de-registered

Returns

Status of deregisterListener i.e. success or suitable error code.

class telux::tel::ICellBroadcastListener

A listener class which monitors cell broadcast messages.

The methods in listener can be invoked from multiple different threads. The implementation should be thread safe.

Public Member Functions
virtual void	onIncomingMessage (SlotId slotId, const std::shared_ptr< CellBroadcastMessage > cbMessage)
virtual void	onMessageFilterChange (SlotId slotId, std::vector< CellBroadcastFilter > filters)
virtual	~ICellBroadcastListener ()
Public Member Functions inherited from telux::common::IServiceStatusListener
virtual void	onServiceStatusChange (ServiceStatus status)
virtual	~IServiceStatusListener ()

Constructor & Destructor Documentation

virtual telux::tel::ICellBroadcastListener::~ICellBroadcastListener ( )

virtual

Member Function Documentation

virtual void telux::tel::ICellBroadcastListener::onIncomingMessage ( SlotId  slotId, const std::shared_ptr< CellBroadcastMessage >  cbMessage  )

virtual

This function is called when device receives an incoming cell broadcast message.

Parameters

[in]	slotId	- Slot Id on which broadcast message is received.
[in]	cbMessage	- Broadcast message with information related to ETWS/CMAS notification.

virtual void telux::tel::ICellBroadcastListener::onMessageFilterChange ( SlotId  slotId, std::vector< CellBroadcastFilter >  filters  )

virtual

This function is called when there is change in broadcast configuration like updation of message filters by the client using ICellBroadcastManager::updateMessageFilters.

Parameters

[in]	slotId	- Slot Id on which change in message filters is received.
[in]	filters	- Complete list of configured broadcast message filters.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

Typedef Documentation

using telux::tel::RequestFiltersResponseCallback = typedef std::function<void(std::vector<CellBroadcastFilter> filters, telux::common::ErrorCode error)>

This function is called with the response to requestMessageIdFilters API.

The callback can be invoked from multiple different threads. The implementation should be thread safe.

Parameters

[in]	filters	List of broadcast filters CellBroadcastFilter
[in]	error	Return code which indicates whether the operation succeeded or not ErrorCode

using telux::tel::RequestActivationStatusResponseCallback = typedef std::function<void(bool isActivated, telux::common::ErrorCode error)>

This function is called with the response to requestActivationStatus API.

The callback can be invoked from multiple different threads. The implementation should be thread safe.

Parameters

[in]	isActivated	If true then filters are activated else filters are deactivated
[in]	error	Return code which indicates whether the operation succeeded or not ErrorCode

Enumeration Type Documentation

enum telux::tel::GeographicalScope

strong

Defines geographical scope of cell broadcast.

Enumerator
CELL_WIDE_IMMEDIATE	Cell wide geographical scope with immediate display
PLMN_WIDE	PLMN wide geographical scope
LA_WIDE
CELL_WIDE	Location / Service/ Tracking area wide geographical scope (GSM/UMTS/E-UTRAN/NG-RAN). Cell wide geographical scope

enum telux::tel::MessagePriority

strong

Defines priority for cell broadcast message.

Enumerator
UNKNOWN	Unknown message priority
NORMAL	Normal message priority
EMERGENCY	Emergency message priority

enum telux::tel::MessageType

strong

Defines message type for cell broadcast message.

Enumerator
UNKNOWN	Unknown message type
ETWS	Earthquake and Tsunami Warning System
CMAS	Commercial Mobile Alert System

enum telux::tel::EtwsWarningType

strong

Defines warning type for ETWS cell broadcast message.

Enumerator
UNKNOWN	Unknown ETWS warning type
EARTHQUAKE	ETWS warning type for earthquake
TSUNAMI	ETWS warning type for tsunami
EARTHQUAKE_AND_TSUNAMI	ETWS warning type for earthquake and tsunami
TEST_MESSAGE	ETWS warning type for test messages
OTHER_EMERGENCY	ETWS warning type for other emergency types

enum telux::tel::CmasMessageClass

strong

Defines message class for CMAS cell broadcast message.

Enumerator
UNKNOWN	CMAS category for warning types that are reserved for future extension
PRESIDENTIAL_LEVEL_ALERT	Presidential-level alert (Korean Public Alert System Class 0 message)
EXTREME_THREAT	Extreme threat to life and property (Korean Public Alert System Class 1 message)
SEVERE_THREAT	Severe threat to life and property (Korean Public Alert System Class 1 message).
CHILD_ABDUCTION_EMERGENCY	Child abduction emergency (AMBER Alert)
REQUIRED_MONTHLY_TEST	CMAS test message
CMAS_EXERCISE	CMAS exercise
OPERATOR_DEFINED_USE	CMAS category for operator defined use

enum telux::tel::CmasSeverity

strong

Defines severity type for CMAS cell broadcast message.

Enumerator
UNKNOWN	CMAS alert severity is unknown. The severity is available for all GSM/UMTS alerts except for the Presidential-level alert class (Korean Public Alert System Class 0).
EXTREME	Extraordinary threat to life or property
SEVERE	Significant threat to life or property

enum telux::tel::CmasUrgency

strong

Defines urgency type for CMAS cell broadcast message.

Enumerator
UNKNOWN	CMAS alert urgency is unknown. The urgency is available for all GSM/UMTS alerts except for the Presidential-level alert class (Korean Public Alert System Class 0).
IMMEDIATE	Responsive action should be taken immediately
EXPECTED	Responsive action should be taken within the next hour

enum telux::tel::CmasCertainty

strong

Defines certainty type for CMAS cell broadcast message.

Enumerator
UNKNOWN	CMAS alert certainty is unknown. The certainty is available for all GSM/UMTS alerts except for the Presidential-level alert class (Korean Public Alert System Class 0).
OBSERVED	Determined to have occurred or to be ongoing.
LIKELY	Likely (probability > ~50%)

enum telux::tel::GeometryType

strong

Defines geometry type specified in wireless emergency alert.

Enumerator
UNKNOWN	Unknown geometry type
POLYGON	Polygon geometry type
CIRCLE	Circle geometry type