cloud.timo.TimoCloud.api

Interface TimoCloudMessageAPI

public interface TimoCloudMessageAPI

Use TimoCloudAPI.getMessageAPI() to get an instance of this API

Method Summary

Modifier and Type	Method and Description
MessageClientAddress	getOwnAddress() Returns the message client address of the TimoCloud application you are on.
void	registerMessageListener(MessageListener listener, java.lang.String... supportedMessageTypes) Registers a message listener
void	sendMessage(AddressedPluginMessage message) Sends an addressed message to the given recipient
void	sendMessageToCord(PluginMessage message, java.lang.String cordName) Sends a message to the cord with the given name
void	sendMessageToCore(PluginMessage message) Sends a message to the core
void	sendMessageToProxy(PluginMessage message, java.lang.String proxyName) Sends a message to the proxy with the given name
void	sendMessageToServer(PluginMessage message, java.lang.String serverName) Sends a message to the server with the given name
void	unregisterMessageListener(MessageListener listener) Unregisters a message listener so that it no longer gets notified of incoming protocol.

Method Detail

sendMessage

void sendMessage(AddressedPluginMessage message)

Sends an addressed message to the given recipient

Parameters:

message - The message which shall be sent

sendMessageToCore

void sendMessageToCore(PluginMessage message)

Sends a message to the core

Parameters:

message - The message which shall be sent

sendMessageToServer

void sendMessageToServer(PluginMessage message,
                         java.lang.String serverName)

Sends a message to the server with the given name

Parameters:

message - The message which shall be sent

serverName - The server the message shall be sent to

sendMessageToProxy

void sendMessageToProxy(PluginMessage message,
                        java.lang.String proxyName)

Sends a message to the proxy with the given name

Parameters:

message - The message which shall be sent

proxyName - The proxy the message shall be sent to

sendMessageToCord

void sendMessageToCord(PluginMessage message,
                       java.lang.String cordName)

Sends a message to the cord with the given name

Parameters:

message - The message which shall be sent

cordName - The cord the message shall be sent to

registerMessageListener

void registerMessageListener(MessageListener listener,
                             java.lang.String... supportedMessageTypes)

Registers a message listener

Parameters:

listener - The listener which shall be registered

supportedMessageTypes - The message types the listener accepts. Leave empty for all types.

unregisterMessageListener

void unregisterMessageListener(MessageListener listener)

Unregisters a message listener so that it no longer gets notified of incoming protocol. This might be useful when your plugin gets reloaded, so that your old listener's instance does not receive protocol anymore

Parameters:

listener - The listener which shall be unregistered

getOwnAddress

MessageClientAddress getOwnAddress()

Returns the message client address of the TimoCloud application you are on. You usually don't need this, as the sender's address will be set automatically by TimoCloud

Returns:

The message client address to which protocol you shall receive can be sent