Halo-Turbo

Android Socket框架

添加依赖

Step 1. Add the JitPack repository to your build file

Add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Step 2. Add the dependency

dependencies {
	compile 'com.github.EthanCo.Halo-Turbo:halo-turbo:2.2.6'
	compile 'com.github.EthanCo.Halo-Turbo:halo-turbo-mina:2.2.6'
	compile 'com.github.EthanCo.Halo-Turbo:json-convertor:2.2.6'
}

halo-turbo是核心库，带有组播功能
halo-turbo-mina:使用TCP需依赖此库
json-convertor:将需发送的对象自动转换为json字符串

使用

注意 : 以下方法都需要在异步线程中进行调用 !!!

TCP client

Halo halo = new Halo.Builder()
    .setMode(Mode.MINA_NIO_TCP_CLIENT)
    .setTargetIP(targetIP)
    .setTargetPort(19701)
    .addHandler(new DemoHandler())
    .build();  
boolean result = halo.start();

TCP Server

 Halo halo = new Halo.Builder()
    .setMode(Mode.MINA_NIO_TCP_SERVER)
    .setSourcePort(19701)
    .addHandler(new DemoHandler())
    .build();
boolean result = halo.start();

组播

Halo halo = new Halo.Builder()
    .setMode(Mode.MULTICAST)
    .setSourcePort(19601)
    .setTargetPort(19602)
    .setTargetIP("224.0.0.1")
    .addHandler(new DemoHandler())
    .build();
boolean result = halo.start();

UDP Client

halo = new Halo.Builder()
    .setMode(Mode.MINA_NIO_UDP_CLIENT)
    .setTargetIP(targetIP)
    .setTargetPort(19701)
    .setContext(context)
    .build();
boolean result = halo.start();

UDP Server

halo = new Halo.Builder()
    .setMode(Mode.MINA_NIO_UDP_SERVER)
    .setSourcePort(19701)
    .setContext(context)
    .build();
boolean result = halo.start();

添加回调处理

new Halo.Builder().addHandler(new DemoHandler())

说明:

可通过addHandler()设置回调
可使用session来发送数据和管理连接

public interface IHandler {
    //会话(session)创建之后，回调该方法
    void sessionCreated(ISession session);

    //会话(session)打开之后，回调该方法
    void sessionOpened(ISession session);

    //会话(session)关闭后，回调该方法
    void sessionClosed(ISession session);

    //接收到消息时回调这个方法
    void messageReceived(ISession session, Object message);

    //发送数据时回调这个方法
    void messageSent(ISession session, Object message);
}

添加心跳

添加心跳后，如果是Client端，如进行断线，会自动进行断线重连。
如果是Server端，收到心跳后，会进行反馈。

 builder.setKeepAlive(new KeepAlive(15, 60, new IKeepAliveListener() {
    @Override
    public void onKeepAliveRequestTimedOut(KeepAlive keepAlive, ISession iSession) {
        //心跳超时
    }

    @Override
    public boolean isKeepAliveMessage(ISession ioSession, Object message) {
        //是否是心跳
    }

    @Override
    public Object getKeepAliveMessage(ISession ioSession, Object o) {
        //返回心跳数据
    }
}))

KeepAlive
interval:每次心跳的间隔时间
timeout:心跳未收到的超时时间
reConnTime:重连间隔时间，默认60秒一次

添加日志打印

new Halo.Builder().addHandler(new StringLogHandler(TAG))

Halo默认实现了如下几个日志打印类，亦可自定义日志打印

StringLogHandler:默认日志打印，打印成字符串
HexLogHandler:Byte日志打印，如果是byte数组，将打印成十六进制

添加转换器

通过连接转换器，可在发送数据时，自动转换为相关类别

new Halo.Builder().addConvert(new ObjectJsonConvertor())

Halo默认提供了如下转换器，亦可自定义转换器

ObjectJsonConvertor:发送Object对象时，自动将其转换为Json字符串

session.write(object);  //发送object时自动转换为json字符串再发送

ObjectJsonByteConvertor:如果是Object对象，则先转换为json字符串后，再转换为byte[]

使用如上转换器，需格外添加依赖

dependencies {
 	//...
	compile 'com.github.EthanCo.Halo-Turbo:json-convertor:X.X.X'
}

setBufferSize

设置Buffer大小

setThreadPool

设置自定义线程池

setCodec

现仅用作Mina设置ProtocolCodecFactory

默认情况下，Halo-Turbo是用于接收、发送String类型数据，每条数据的结尾都会加上\n用于区分多条数据。(如果是普通的Socket 发送数据给Halo-Turbo，普通Socket发送的数据在发送时需要手动在数据末尾添加\n) 如果需要自定义分隔标识符，可以进行如下设置。

builder.setCodec(new TextLineCodecFactory(
Charset.forName(编码格式 - 比如UTF-8), encode的分隔标识符, decode的分隔标识符)

如果不是发送String类型的数据，需要通过builder.setCodec设置不同的解码类
TextLineCodecFactory：基于文本的，根据回车换行来断点传输数据
ProtocolCodecFactory：自定义协议的编解码数据传输
ObjectSerializationCodecFactory：对象序列化传输
DemuxingProtocolCodecFactory：复用传输

其他

具体详见Sample

EthanCo/Halo-Turbo