Class GroupBase
Definition
- Namespace:
- Tizen.Applications.Cion
- Assembly:
- Tizen.Applications.Cion.dll
An abstract class to represent cion group.
public abstract class GroupBase : IDisposable
- Inheritance
-
objectGroupBase
- Implements
-
System.IDisposable
Constructors
View SourceGroupBase(string, SecurityInfo)
The constructor of GroupBase class.
Declaration
public GroupBase(string topicName, SecurityInfo security)
Parameters
Type | Name | Description |
---|---|---|
string | topicName | The topic of group. |
SecurityInfo | security | The security configuration. |
Remarks
The maximum length of topic name is 512.
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the given topic name is too long. |
System.InvalidOperationException | Thrown when there is not enough memory to continue the execution of the method. |
GroupBase(string)
The constructor of GroupBase class.
Declaration
public GroupBase(string topicName)
Parameters
Type | Name | Description |
---|---|---|
string | topicName | The topic of group. |
Remarks
The maximum length of topic name is 512.
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the given topic name is too long. |
System.InvalidOperationException | Thrown when there is not enough memory to continue the execution of the method. |
Properties
View SourceTopic
Gets the topic of current cion group.
Declaration
public string Topic { get; }
Property Value
Type | Description |
---|---|
string |
Methods
View SourceDispose()
Releases all resources used by the GroupBase 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. |
OnJoined(PeerInfo)
The callback invoked when another peer joined in the current group.
Declaration
protected abstract void OnJoined(PeerInfo peerInfo)
Parameters
Type | Name | Description |
---|---|---|
PeerInfo | peerInfo | The peer info of joined in the current group. |
OnLeft(PeerInfo)
The callback invoked when another peer left from the current group.
Declaration
protected abstract void OnLeft(PeerInfo peerInfo)
Parameters
Type | Name | Description |
---|---|---|
PeerInfo | peerInfo | The peer info of left from the current group. |
OnPayloadReceived(Payload, PeerInfo)
The callback invoked when payload received.
Declaration
protected abstract void OnPayloadReceived(Payload payload, PeerInfo peer)
Parameters
Type | Name | Description |
---|---|---|
Payload | payload | |
PeerInfo | peer |
Publish(Payload)
Publishes payload to current group.
Declaration
public void Publish(Payload payload)
Parameters
Type | Name | Description |
---|---|---|
Payload | payload | The payload to publish. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the payload is invalid. |
System.InvalidOperationException | Thrown when failed to publish. |
Subscribe()
Subscribes the topic.
Declaration
public void Subscribe()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when failed to subscribe. |
System.UnauthorizedAccessException | Thrown when an application does not have the privilege to access this method. |
Unsubscribe()
Unsubscribes the topic.
Declaration
public void Unsubscribe()