Class RemotePort
Definition
- Namespace:
- Tizen.Applications.Messages
- Assembly:
- Tizen.Applications.MessagePort.dll
The RemotePort Class provides functions to get if the remote port is running and to get whether the remote port is registered or unregistered.
public class RemotePort : IDisposable
- Inheritance
-
objectRemotePort
- Implements
-
System.IDisposable
Constructors
View SourceRemotePort(string, string, bool)
Constructor of the RemotePort class.
Declaration
public RemotePort(string appId, string portName, bool trusted)
Parameters
Type | Name | Description |
---|---|---|
string | appId | The Id of the remote application |
string | portName | The name of the remote message port |
bool | trusted | If true is the trusted message port of application, otherwise false |
Examples
RemotePort remotePort = new RemotePort("org.tizen.example.messageport", "SenderPort", false);
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when appId is null or empty, when portName is null or empty |
Properties
View SourceAppId
The AppId of the remote port
Declaration
public string AppId { get; }
Property Value
Type | Description |
---|---|
string | Return appid of RemotePort |
PortName
The name of the remote message port
Declaration
public string PortName { get; }
Property Value
Type | Description |
---|---|
string | Return name of RemotePort |
Trusted
If true the remote port is a trusted port, otherwise if false it is not
Declaration
public bool Trusted { get; }
Property Value
Type | Description |
---|---|
bool | Return true if RemotePort is trusted |
Methods
View SourceDispose()
Releases all resources used by the RemotePort class.
Declaration
public void Dispose()
Dispose(bool)
Releases the unmanaged resources used by the RemotePort class specifying whether to perform a normal dispose operation.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true for a normal dispose operation; false to finalize the handle. |
~RemotePort()
Destructor of the RemotePort class.
Declaration
protected ~RemotePort()
IsRunning()
Check if the remote message port is running.
Declaration
public bool IsRunning()
Returns
Type | Description |
---|---|
bool | Return true if Remote Port is running |
Examples
Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);
bool isRunning = remotePort.isRunning();
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when there is an I/O error |
System.OutOfMemoryException | Thrown when out of memory. |
Events
View SourceRemotePortStateChanged
Called when the remote port is registered or unregistered.
Declaration
public event EventHandler<RemotePortStateChangedEventArgs> RemotePortStateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><RemotePortStateChangedEventArgs> |
Examples
Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);
remotePort.RemotePortStateChanged += RemotePortStateChangedCallback;
static void RemotePortStateChangedCallback(object sender, RemotePortStateChangedEventArgs e)
{
switch (e.Status)
{
case State.Registered :
Console.WriteLine("Remote Port Registered ");
break;
case State.Unregistered :
Console.WriteLine("Remote Port Unregistered ");
break;
default :
break;
}
}
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when there is an I/O error |
System.OutOfMemoryException | Thrown when out of memory. |