Class GroupBase

Definition

Namespace:
Tizen.Applications.Cion
Assembly:
Tizen.Applications.Cion.dll

An abstract class to represent cion group.

C#
Copy
public abstract class GroupBase : IDisposable
Inheritance
object
GroupBase
Implements
System.IDisposable

Constructors

View Source

GroupBase(string, SecurityInfo)

The constructor of GroupBase class.

Declaration
C#
Copy
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.

View Source

GroupBase(string)

The constructor of GroupBase class.

Declaration
C#
Copy
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 Source

Topic

Gets the topic of current cion group.

Declaration
C#
Copy
public string Topic { get; }
Property Value
Type Description
string

Methods

View Source

Dispose()

Releases all resources used by the GroupBase class.

Declaration
C#
Copy
public void Dispose()
View Source

Dispose(bool)

Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.

Declaration
C#
Copy
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.

View Source

OnJoined(PeerInfo)

The callback invoked when another peer joined in the current group.

Declaration
C#
Copy
protected abstract void OnJoined(PeerInfo peerInfo)
Parameters
Type Name Description
PeerInfo peerInfo

The peer info of joined in the current group.

View Source

OnLeft(PeerInfo)

The callback invoked when another peer left from the current group.

Declaration
C#
Copy
protected abstract void OnLeft(PeerInfo peerInfo)
Parameters
Type Name Description
PeerInfo peerInfo

The peer info of left from the current group.

View Source

OnPayloadReceived(Payload, PeerInfo)

The callback invoked when payload received.

Declaration
C#
Copy
protected abstract void OnPayloadReceived(Payload payload, PeerInfo peer)
Parameters
Type Name Description
Payload payload
PeerInfo peer
View Source

Publish(Payload)

Publishes payload to current group.

Declaration
C#
Copy
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.

View Source

Subscribe()

Subscribes the topic.

Declaration
C#
Copy
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.

View Source

Unsubscribe()

Unsubscribes the topic.

Declaration
C#
Copy
public void Unsubscribe()

Implements

System.IDisposable