Class ClientBase
Definition
- Namespace:
- Tizen.Applications.Cion
- Assembly:
- Tizen.Applications.Cion.dll
An abstract class to represent cion client.
public abstract class ClientBase : IDisposable
- Inheritance
-
objectClientBase
- Implements
-
System.IDisposable
Constructors
View SourceClientBase(string, SecurityInfo)
The constructor of ClientBase class.
Declaration
public ClientBase(string serviceName, SecurityInfo security)
Parameters
Type | Name | Description |
---|---|---|
string | serviceName | The name of service. |
SecurityInfo | security | The security configuration. |
Remarks
The maximum length of service name is 512.
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the given service name is too long. |
System.InvalidOperationException | Thrown when there is not enough memory to continue the execution of the method. |
ClientBase(string)
The constructor of ClientBase class.
Declaration
public ClientBase(string serviceName)
Parameters
Type | Name | Description |
---|---|---|
string | serviceName | The name of service. |
Remarks
The maximum length of service name is 512.
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the given service name is too long. |
System.InvalidOperationException | Thrown when there is not enough memory to continue the execution of the method. |
Properties
View SourcePeerInfo
Gets peer info of connected cion server.
Declaration
public PeerInfo PeerInfo { get; }
Property Value
Type | Description |
---|---|
PeerInfo |
ServiceName
Gets the service name of current cion client.
Declaration
public string ServiceName { get; }
Property Value
Type | Description |
---|---|
string |
Methods
View SourceConnect(PeerInfo)
Connects with the cion server.
Declaration
public void Connect(PeerInfo peer)
Parameters
Type | Name | Description |
---|---|---|
PeerInfo | peer | The peer to connect. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when the client cannot connect to server. |
System.UnauthorizedAccessException | Thrown when an application does not have the privilege to access this method. |
Disconnect()
Disconnects from the cion server.
Declaration
public void Disconnect()
Dispose()
Releases all resources used by the ClientBase class.
Declaration
public void Dispose()
Dispose(bool)
Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | If true, disposes any disposable objects. If false, does not dispose disposable objects. |
OnConnectionResult(PeerInfo, ConnectionResult)
The result callback of connection request.
Declaration
protected abstract void OnConnectionResult(PeerInfo peerInfo, ConnectionResult result)
Parameters
Type | Name | Description |
---|---|---|
PeerInfo | peerInfo | The peer info of the cion server. |
ConnectionResult | result | The result of the connection. |
OnDisconnected(PeerInfo)
The callback invoked when disconnected with cion client.
Declaration
protected abstract void OnDisconnected(PeerInfo peerInfo)
Parameters
Type | Name | Description |
---|---|---|
PeerInfo | peerInfo | The peer info of the cion server. |
OnDiscovered(PeerInfo)
The callback invoked when the cion server discovered.
Declaration
protected abstract void OnDiscovered(PeerInfo peerInfo)
Parameters
Type | Name | Description |
---|---|---|
PeerInfo | peerInfo | The peer info of discovered cion server. |
OnPayloadReceived(Payload, PayloadTransferStatus)
The callback invoked when received payload.
Declaration
protected abstract void OnPayloadReceived(Payload payload, PayloadTransferStatus status)
Parameters
Type | Name | Description |
---|---|---|
Payload | payload | The received payload. |
PayloadTransferStatus | status | The status of sent payload. |
SendData(byte[], int)
Sends data synchronously to the connected cion server.
Declaration
public byte[] SendData(byte[] data, int timeout)
Parameters
Type | Name | Description |
---|---|---|
byte[] | data | The data to send. |
int | timeout | The timeout of sending operation. |
Returns
Type | Description |
---|---|
byte[] |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the given data is invalid. |
System.InvalidOperationException | Thrown when there is no connected cion server or failed to receive reply. |
System.TimeoutException | Thrown when a timeout occurred. |
SendPayloadAsync(Payload)
Sends payload asynchronously to the connected cion server.
Declaration
public Task<PayloadAsyncResult> SendPayloadAsync(Payload payload)
Parameters
Type | Name | Description |
---|---|---|
Payload | payload | The payload to send. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><PayloadAsyncResult> |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the payload is not valid. |
System.InvalidOperationException | Thrown when there is no connected cion server or failed to send payload. |
StopDiscovery()
Stops discovering.
Declaration
public void StopDiscovery()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when the client is not discovering. |
TryDiscovery()
Starts discovering cion servers.
Declaration
public void TryDiscovery()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when the discovery operation is already in progress. |
System.UnauthorizedAccessException | Thrown when an application does not have the privilege to access this method. |