Class SsdpService

    Definition

    Namespace:
    Tizen.Network.Nsd
    Assembly:
    Tizen.Network.Nsd.dll

    This class is used for managing the local service registration and its properties using SSDP.

    public class SsdpService : INsdService, IDisposable
    Inheritance
    object
    SsdpService
    Implements
    INsdService
    System.IDisposable

    Constructors

    View Source

    SsdpService(string)

    The constructor to create the SsdpService instance that sets the target to a given value.

    Declaration
    public SsdpService(string target)
    Parameters
    Type Name Description
    string target

    The SSDP local service's target. It may be a device type or a service type.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown while setting this property when SSDP is not supported.

    System.ArgumentException

    Thrown when the target is set to null.

    Properties

    View Source

    Target

    Target of the SSDP service.

    Declaration
    public string Target { get; }
    Property Value
    Type Description
    string
    Remarks

    It may be a device type or a service type specified in the UPnP forum (http://upnp.org). In case of an error, null will be returned.

    View Source

    Url

    URL of the SSDP service.

    Declaration
    public string Url { get; set; }
    Property Value
    Type Description
    string
    Remarks

    Set the URL for only an unregistered service created locally. If the service is already registered, the URL will not be set. In case of an error, null will be returned during get and exception will be thrown during set.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown while setting this property when SSDP is not supported.

    System.ArgumentException

    Thrown when the URL value is set to null.

    System.InvalidOperationException

    Thrown while setting this property when any other error occurred.

    View Source

    Usn

    Unique Service Name of the SSDP service.

    Declaration
    public string Usn { get; set; }
    Property Value
    Type Description
    string
    Remarks

    Set the USN for only an unregistered service created locally. If the service is already registered, the USN will not be set. In case of an error, null will be returned during get and exception will be thrown during set.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown while setting this property when SSDP is not supported.

    System.ArgumentException

    Thrown when USN value is set to null.

    System.InvalidOperationException

    Thrown while setting this property when any other error occurred.

    Methods

    View Source

    DeregisterService()

    Deregisters the SSDP local service.

    Declaration
    public void DeregisterService()
    Remarks

    A local service registered using RegisterService() must be passed.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Thrown when any other error occurred.

    System.NotSupportedException

    Thrown when the SSDP is not supported.

    View Source

    Dispose()

    Disposes the memory allocated to unmanaged resources.

    Declaration
    public void Dispose()
    View Source

    ~SsdpService()

    Destroys the SsdpService object.

    Declaration
    protected ~SsdpService()
    View Source

    RegisterService()

    Registers the SSDP local service for publishing.

    Declaration
    public void RegisterService()
    Remarks

    A service created locally must be passed. URL and USN of the service must be set before the RegisterService is called.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Thrown when any other error occurred.

    System.NotSupportedException

    Thrown when the SSDP is not supported.

    System.UnauthorizedAccessException

    Thrown when the permission is denied.

    Implements

    INsdService
    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX