com.taobao.api.internal.tmc

Class TmcClient

java.lang.Object

com.taobao.api.internal.tmc.TmcClient

public class TmcClient
extends Object

消息服务客户端入口。

Since:

1.0, May 4, 2013

Author:

fengsheng

Constructor Summary

Constructors

Constructor and Description
TmcClient(String appKey, String appSecret)
TmcClient(String appKey, String appSecret, String groupName)
TmcClient(String uri, String appKey, String appSecret, String groupName)
TmcClient(String uri, String appKey, String appSecret, String groupName, String minorGroup)
TmcClient(String uri, String appKey, String appSecret, String groupName, String minorGroup, String filterExp)

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(String reason) 关闭TMC长连接并释放所有资源。
void	connect() 连接到线上服务器。
void	connect(String uri) 连接到指定的服务器。
void	connect(String uri, boolean async) 连接到指定的服务器。
String	getApiUrl()
protected String	getAppKey()
protected com.taobao.api.internal.tmc.TmcClient.InnerClient	getClient()
ThreadPoolExecutor	getConfirmThreadPool()
String	getFilterExp()
protected String	getGroupName()
protected KeySelector	getKeySelector()
protected MessageHandler	getMessageHandler()
String	getMinorGroup()
String	getOutId()
protected int	getQueueSize()
protected ThreadPoolExecutor	getThreadPool()
protected com.taobao.api.internal.tmc.TmcHandler	getTmcHandler()
boolean	isOnline() 检查TMC长连接是否存活。
boolean	isUseDefaultConfirm()
void	manualConfirm(Long outGoingId)
void	manualConfirm(Message message)
protected void	pullRequest()
void	retryMessage(Message message)
void	send(String topic, String content) 向指定的主题发布一条与用户无关的消息。
void	send(String topic, String content, String session) 向指定的主题发布一条与用户相关的消息。
void	setAuthApiUrl(String apiUrl)
void	setConfirmThreadCount(int threadCount)
void	setFetchPeriod(int fetchPeriod)
void	setKeySelector(KeySelector keySelector)
void	setMessageHandler(MessageHandler handler)
void	setOutId(String outId)
void	setQueueSize(int queueSize)
void	setRemoveDuplicate(boolean removeDuplicate)
void	setThreadCount(int threadCount)
protected void	setUri(String uri)
void	setUseDefaultConfirm(boolean useDefaultConfirm)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TmcClient

public TmcClient(String appKey,
                 String appSecret)

TmcClient

public TmcClient(String appKey,
                 String appSecret,
                 String groupName)

TmcClient

public TmcClient(String uri,
                 String appKey,
                 String appSecret,
                 String groupName)

TmcClient

public TmcClient(String uri,
                 String appKey,
                 String appSecret,
                 String groupName,
                 String minorGroup)

TmcClient

public TmcClient(String uri,
                 String appKey,
                 String appSecret,
                 String groupName,
                 String minorGroup,
                 String filterExp)

Method Detail

getMinorGroup

public String getMinorGroup()

getFilterExp

public String getFilterExp()

setUri

protected void setUri(String uri)

getAppKey

protected String getAppKey()

getGroupName

protected String getGroupName()

getClient

protected com.taobao.api.internal.tmc.TmcClient.InnerClient getClient()

getThreadPool

protected ThreadPoolExecutor getThreadPool()

getConfirmThreadPool

public ThreadPoolExecutor getConfirmThreadPool()

getMessageHandler

protected MessageHandler getMessageHandler()

setMessageHandler

public void setMessageHandler(MessageHandler handler)

getTmcHandler

protected com.taobao.api.internal.tmc.TmcHandler getTmcHandler()

getQueueSize

protected int getQueueSize()

getApiUrl

public String getApiUrl()

setAuthApiUrl

public void setAuthApiUrl(String apiUrl)

setQueueSize

public void setQueueSize(int queueSize)

setThreadCount

public void setThreadCount(int threadCount)

setConfirmThreadCount

public void setConfirmThreadCount(int threadCount)

getOutId

public String getOutId()

setOutId

public void setOutId(String outId)

setFetchPeriod

public void setFetchPeriod(int fetchPeriod)

setRemoveDuplicate

public void setRemoveDuplicate(boolean removeDuplicate)

getKeySelector

protected KeySelector getKeySelector()

setKeySelector

public void setKeySelector(KeySelector keySelector)

connect

public void connect()
             throws LinkException

连接到线上服务器。

Throws:

LinkException

connect

public void connect(String uri)
             throws LinkException

连接到指定的服务器。

Parameters:

uri - 消息服务地址，线上或沙箱

Throws:

LinkException

connect

public void connect(String uri,
                    boolean async)
             throws LinkException

连接到指定的服务器。

Parameters:

uri - 消息服务地址，线上或沙箱

async - 是否异步的发起连接

Throws:

LinkException

send

public void send(String topic,
                 String content)
          throws LinkException

向指定的主题发布一条与用户无关的消息。

Parameters:

topic - 主题名称

content - 严格根据主题定义的消息内容（JSON/XML）

Throws:

LinkException

send

public void send(String topic,
                 String content,
                 String session)
          throws LinkException

向指定的主题发布一条与用户相关的消息。

Parameters:

topic - 主题名称

content - 严格根据主题定义的消息内容（JSON/XML）

session - 用户授权码

Throws:

LinkException

manualConfirm

public void manualConfirm(Message message)

manualConfirm

public void manualConfirm(Long outGoingId)

retryMessage

public void retryMessage(Message message)
                  throws RejectedExecutionException

Throws:

RejectedExecutionException

close

public void close()

close

public void close(String reason)

关闭TMC长连接并释放所有资源。

Parameters:

reason - 关闭的原因

isOnline

public boolean isOnline()

检查TMC长连接是否存活。

pullRequest

protected void pullRequest()

isUseDefaultConfirm

public boolean isUseDefaultConfirm()

setUseDefaultConfirm

public void setUseDefaultConfirm(boolean useDefaultConfirm)
                          throws InterruptedException

Throws:

InterruptedException