Class IoTConnectivityClientManager

Definition

Namespace:

Tizen.Network.IoTConnectivity

Assembly:

Tizen.Network.IoTConnectivity.dll

API Level:

3

                
C#
                

                    
Copy
                    

                
            
public static class IoTConnectivityClientManager

Inheritance

System.Object

IoTConnectivityClientManager

Fields

Declaration

                
C#
                

                    
Copy
                    

                
            
public const string MulticastAddress = null

Field Value

API Level: 3

Properties

Declaration

                
C#
                

                    
Copy
                    

                
            
public static int PollingInterval { get; set; }

Property Value

Examples

                

                

                    
Copy
                    

                
            
    IoTConnectivityClientManager.Initialize();
    IoTConnectivityClientManager.PollingInterval = 100;

API Level: 3

Precondition: Initialize() should be called to initialize.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static int TimeOut { get; set; }

Property Value

Examples

                

                

                    
Copy
                    

                
            
    IoTConnectivityClientManager.Initialize();
    IoTConnectivityClientManager.TimeOut = 120;

API Level: 3

Precondition: Initialize() should be called to initialize.

Methods

Declaration

                
C#
                

                    
Copy
                    

                
            
public static void Deinitialize()

Remarks

Examples

                

                

                    
Copy
                    

                
            
    IoTConnectivityClientManager.Deinitialize();

API Level: 3

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static void Initialize(string filePath)

Parameters

Remarks

Examples

                

                

                    
Copy
                    

                
            
    string filePath = "../../res/iotcon-test-svr-db-client.dat";
    IoTConnectivityClientManager.Initialize(filePath);

Exceptions

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/network.gethttp://tizen.org/privilege/internet

Feature: http://tizen.org/feature/iot.ocf

Postcondition: You must call Deinitialize() if IoTCon API is no longer needed.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static void InvokePolling()

Remarks

Examples

                

                

                    
Copy
                    

                
            
    IoTConnectivityClientManager.InvokePolling();

Exceptions

API Level: 3

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static int StartFindingDeviceInformation(string hostAddress, ResourceQuery query = null)

Parameters

Returns

Remarks

Examples

                

                

                    
Copy
                    

                
            
    EventHandler<DeviceInformationFoundEventArgs> handler = (sender, e) => {
        Console.Log("Device information found, id : " + e.RequestId + ", name : " + e.Name);
    }
    EventHandler<FindingErrorOccurredEventArgs> errorHandler = (sender, e) => {
        Console.Log("Found error :" + e.Error.Message);
    }
    IoTConnectivityClientManager.DeviceInformationFound += handler;
    IoTConnectivityClientManager.FindingErrorOccurred += errorHandler;
    // Do not forget to remove these event handlers when they are not required any more.
    int id = IoTConnectivityClientManager.StartFindingDeviceInformation(IoTConnectivityClientManager.MulticastAddress);

Exceptions

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/internet

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Postcondition: event handler will be invoked.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static int StartFindingPlatformInformation(string hostAddress, ResourceQuery query = null)

Parameters

Returns

Remarks

Examples

                

                

                    
Copy
                    

                
            
    EventHandler<PlatformInformationFoundEventArgs> handler = (sender, e) => {
        Console.Log("PlatformInformationFound :" + e.RequestId);
    }
    EventHandler<FindingErrorOccurredEventArgs> errorHandler = (sender, e) => {
        Console.Log("Found error :" + e.Error.Message);
    }
    IoTConnectivityClientManager.PlatformInformationFound += handler;
    IoTConnectivityClientManager.FindingErrorOccurred += errorHandler;
    // Do not forget to remove these event handlers when they are not required any more.
    int id = IoTConnectivityClientManager.StartFindingPlatformInformation(IoTConnectivityClientManager.MulticastAddress);

Exceptions

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/internet

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Postcondition: event handler will be invoked.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static int StartFindingResource(string hostAddress, ResourceQuery query = null)

Parameters

Returns

Remarks

Examples

                

                

                    
Copy
                    

                
            
    EventHandler<ResourceFoundEventArgs> handler = (sender, e) => {
        Console.Log("Found resource at host address :" + e.Resource.HostAddress + ", uri :" + e.Resource.UriPath);
    }
    EventHandler<FindingErrorOccurredEventArgs> errorHandler = (sender, e) => {
        Console.Log("Found error :" + e.Error.Message);
    }
    IoTConnectivityClientManager.ResourceFound += handler;
    IoTConnectivityClientManager.FindingErrorOccurred += errorHandler;
    ResourceQuery query = new ResourceQuery();
    query.Type = "oic.iot.door";
    // Do not forget to remove these event handlers when they are not required any more.
    int id = IoTConnectivityClientManager.StartFindingResource(null, query);

Exceptions

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/internet

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Postcondition: When the resource is found, event handler will be invoked.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static int StartReceivingPresence(string hostAddress, string resourceType)

Parameters

Returns

Remarks

Examples

                

                

                    
Copy
                    

                
            
    EventHandler<PresenceReceivedEventArgs> handler = (sender, e) => {
        Console.Log("PresenceReceived, presence id :" + e.PresenceId);
    }
    EventHandler<FindingErrorOccurredEventArgs> errorHandler = (sender, e) => {
        Console.Log("Found error :" + e.Error.Message);
    }
    IoTConnectivityClientManager.PresenceReceived += handler;
    IoTConnectivityClientManager.FindingErrorOccurred += errorHandler;
    // Do not forget to remove these event handlers when they are not required any more.
    int id = IoTConnectivityClientManager.StartReceivingPresence(IoTConnectivityClientManager.MulticastAddress, "oic.iot.door");

Exceptions

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/internet

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Postcondition: When the resource receive presence, event handler will be invoked. You must destroy presence by calling StopReceivingPresence() if presence event is no longer needed.

Declaration

                
C#
                

                    
Copy
                    

                
            
public static void StopReceivingPresence(int presenceId)

Parameters

Remarks

Examples

                

                

                    
Copy
                    

                
            
    EventHandler<PresenceReceivedEventArgs> handler = (sender, e) => {
        Console.Log("PresenceReceived, presence id :" + e.PresenceId);
    }
    EventHandler<FindingErrorOccurredEventArgs> errorHandler = (sender, e) => {
        Console.Log("Found error :" + e.Error.Message);
    }
    IoTConnectivityClientManager.PresenceReceived += handler;
    IoTConnectivityClientManager.FindingErrorOccurred += errorHandler;
    int id = IoTConnectivityClientManager.StartReceivingPresence(IoTConnectivityClientManager.MulticastAddress, "oic.iot.door");
    await Task.Delay(5000); // Do other things here
    // Call StopReceivingPresence() when receiving presence is not required any more
    IoTConnectivityClientManager.PresenceReceived -= handler;
    IoTConnectivityClientManager.FindingErrorOccurred -= errorHandler;
    IoTConnectivityClientManager.StopReceivingPresence(id);

Exceptions

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/internet

Feature: http://tizen.org/feature/iot.ocf

Precondition: Initialize() should be called to initialize.

Events

Declaration

                
C#
                

                    
Copy
                    

                
            
public static event EventHandler<DeviceInformationFoundEventArgs> DeviceInformationFound

Event Type

API Level: 3

Declaration

                
C#
                

                    
Copy
                    

                
            
public static event EventHandler<FindingErrorOccurredEventArgs> FindingErrorOccurred

Event Type

API Level: 3

Declaration

                
C#
                

                    
Copy
                    

                
            
public static event EventHandler<PlatformInformationFoundEventArgs> PlatformInformationFound

Event Type

API Level: 3

Declaration

                
C#
                

                    
Copy
                    

                
            
public static event EventHandler<PresenceReceivedEventArgs> PresenceReceived

Event Type

API Level: 3

Declaration

                
C#
                

                    
Copy
                    

                
            
public static event EventHandler<ResourceFoundEventArgs> ResourceFound

Event Type

API Level: 3