MatchingEngine class MobiledgeX MatchingEngine APIs

Each instance of MatchingEngine class contains MatchingEngineState Holds information about app instance, information required for MatchingEngine API calls, and any necessary device info

MobiledgeX Location Services for easy location service integration with application

Contains functions related to network interfaces (cellular, wifi)

Class that allows developers to easily test latency of their various backend servers. This is used in the implementation of FindCloudlet Performance Mode.

Object used by NetTest to test latency of server. Each site object contains the server path or host + port, avg latency, standard deviation, list of latency times, and the TestType. TestType is either PING or CONNECT, where PING is ICMP Ping (not implemented) and CONNECT is is actually setting up a connection and then disconnecting immediately.

AppInstListRequest struct Request object sent via GetAppInstList from client side to DME Request requires session_cookie from RegisterClientReply, gps_location, and carrier_name

AppInstListReply struct Reply object received via GetAppInstList If an application instance exists, this will return AI_SUCCESS. Will provide information about all application instances deployed on specified carrier network

Object returned in AppInstListReply cloudlets field The geo-location of Cloudlets (resources) within the Operator's Telco infrastructure, where Developers can create and deploy application instances to the available Cloudlets.

Object returned in CloudletLocation appinstances field Information about specific app instances

FindCloudletRequest struct Request object sent via FindCloudlet from client side to DME Request requires session_cookie from RegisterClientReply, gps_location, and carrier_name

FindCloudletReply struct Reply object received via FindCloudlet If application instance exists, this will return FIND_FOUND and contain information about the application instance.

Object returned in ports of several API replies

Object used in timestamp field of Loc

Object used and returned in gps_location field of serveral API requests and replies

QosPositionKpiRequest struct Request object sent via GetQosPositionKpi from client side to DME Request requires session_cookie from RegisterClientReply and an array of QosPositions

Object in positions field in QosPositionRequest Object that contains gps location and id for that gps location

Object in QosPositionRequest band_selection field Each field's value is an array of Strings Supported band values

QosPositionKpiReply struct Reply object received via GetQosPositionKpi If an application instance exists, this will return RS_SUCCESS. Will provide quality of service information for gps locations specified

Object returned in position_results field of QosPositionKpiReply Qos results for specific location

RegisterClientRequest struct Request object sent via RegisterClient from client side to DME Request requires org_name, app_name, and app_vers

RegisterClientReply struct Reply object received via RegisterClient If application exists, this will return RS_SUCCESS and contain a session cookie to be used in other DME APIs

VerifyLocationRequest struct Request object sent via VerifyLocation from client side to DME

VerifyLocationReply struct Reply object received via VerifyLocation If verified, will return LOC_VERIFIED and CONNECTED_TO_SPECIFIED_TOWER Also contains information about accuracy of provided gps location

Socket struct returned by some GetConnection functions

Values for AppInstList status field

Values for FindCloudletReply status enum

Two modes to call FindCloudlet. First is Proximity (default) which finds the nearest cloudlet based on gps location with application instance Second is Performance. This mode will test all cloudlets with application instance deployed to find cloudlet with lowest latency. This mode takes longer to finish because of latency test.

Errors on GetConnection

Errors related to trying to get a telco edge connection

L4 and L7 protocols supported by MobiledgeX iOS GetConnection

MatchingEngine API errors

Occurs when VerifyLocation API is unable to communicate with token server

Occurs on bad HTTP requests

IDTypes used for unique_id_type in RegisterClientRequest??

Values for RegisterClientReply, DynamicLocGroupReply, and QosPositionKpiReply status field

Values for AppPort proto field

Values for VerifyLocationReply tower_status field

Values for VerifyLocationReply gps_location_status field

Types of Location ServiceTypes, reflects built-in methods that iOS uses to get location Visits: Only updates location when user spends time at location and then moves (the most power-efficient) SignificantChange : Updates location when user's location significantly changes Standard: For real time location updates (requires most power)

Swift MobiledgeX SDK namespace Used for "namespacing" purposes to prevent naming conflicts from common names (Util, NetworkInterface, etc.)

Occurs when MobiledgeX does not have user's MCC and MNC mapped to a DME

Occurs when GetConnection function using bsd sockets has an error

Generic error from MobiledgeX SDK

TestType is either PING or CONNECT, where PING is ICMP Ping (not implemented) and CONNECT is is actually setting up a connection and then disconnecting immediately.

Namespace for collecting network performance. Contains NetTest and Site classes