# LanguageSockets

**Repository Path**: dingxiaowei/LanguageSockets

## Basic Information

- **Project Name**: LanguageSockets
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-11-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pytools

## socket通讯自定义协议生成工具

## 依赖环境
* python 2.7.x

## 支持语言
* [erlang](examples/erlang)
* [c#](examples/csharp)
* [golang](examples/golang)
* [c++](examples/cpp)
* [java](examples/java)
* [lua](examples/lua)
* [lua53](examples/lua53)
* [python](examples/python)
* [php](examples/php)

## 使用方法
找到 conf.py 文件, 修改 data_proto 配置(原始协议文件目录) 例:  
```python
DEBUG				= True

data_dir            = os.path.join(os.path.dirname(__file__), '../')
if DEBUG:
	data_dir        = os.path.join(os.path.dirname(__file__), './data/')	# data目录

data_proto			= data_dir + 'data.proto/'	# data/data.proto目录
```
修改 langs_proto 这个配置(导出语言), 例:  
```python
langs_proto = [
    {
        'lang':     'csharp_client',
        'code':     'data.code.csharp.client',
    },
    {
        'lang':     'csharp_server',
        'code':     'data.code.csharp.server',
    },
    {
        'lang':     'golang_server',
        'code':     'data.code.golang.server',
    },
    {
        'lang':     'golang_client',
        'code':     'data.code.golang.client',
    },
]
```
运行导出脚本  
```shell
python doproto.py
```
就会在langs_proto配置的 code 项的目录下面生成特定语言的协议文件

## 原始协议文件约定
每条协议都以 message 协议名(协议ID) 开头, 然后回车后以左大括号 { 加回车, 然后是具体的协议字段, 最后以右大括号 } 加回车结束  
协议名以 C 开头代表客户端请求, S 开头代表服务端返回, Msg开头代表协议块  
协议字段选项有3种格式: required repeated optional  
* required		必填字段, 没填写为类型默认值
* repeated		列表字段, 两个字节代表长度, 后面为列表数据
* optional		可选字段, 一个字节标志, 1表示有数据, 后为具体数据, 0表示无数据  

具体协议字段 字段选项 字段类型 字段名称: 如 required string uname  
协议类型有: u8 i8 u16 i16 u32 i32 u64 i64 string Msg自定义  

具体协议:  
```python
message CTestXX(50000)
{
	required	u16 		id16
	repeated	u8 			idu8s
	optional 	MsgTestXX	msgxx
}

message STestXX(50000)
{
	required	u16 		id16
	repeated	u8 			idu8s
	optional 	MsgTestXX	msgxx
}

message MsgTestXX(50000)
{
	required	string		uname
}
```

具体还是看支持语言的具体例子吧, 每个都写了socket服务端和客户端, 粘包也做了处理