├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── _examples ├── goclient │ └── client.go ├── goserver │ └── server.go └── netty │ ├── .idea │ ├── compiler.xml │ ├── encodings.xml │ ├── inspectionProfiles │ │ └── Project_Default.xml │ ├── libraries │ │ └── Maven__io_netty_netty_all_4_1_10_Final.xml │ ├── misc.xml │ ├── modules.xml │ └── workspace.xml │ ├── pom.xml │ └── src │ └── main │ └── java │ └── com │ └── colobu │ ├── Client.java │ ├── ClientHandler.java │ ├── Server.java │ └── ServerHandler.java ├── delimiter_based_frameconn.go ├── error.go ├── fixed_length_frameconn.go ├── frame.go ├── frame_test.go ├── go.mod ├── go.sum ├── length_field_based_frameconn.go ├── line_based_frameconn.go └── util.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | *.prof 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | go: 4 | - 1.8.x 5 | 6 | before_script: 7 | - go get -t -v github.com/smallnest/goframe/... 8 | 9 | script: 10 | - go test -v ./... 11 | 12 | notifications: 13 | email: 14 | recipients: smallnest@gmail.com 15 | on_success: change 16 | on_failure: always -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # goframe 2 | [goframe](https://github.com/smallnest/goframe) provides wrapped net.Conn that can send and receive framed data. 3 | 4 | [![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GoDoc](https://godoc.org/github.com/smallnest/goframe?status.png)](http://godoc.org/github.com/smallnest/goframe) [![travis](https://travis-ci.org/smallnest/goframe.svg?branch=master)](https://travis-ci.org/smallnest/goframe) [![Go Report Card](https://goreportcard.com/badge/github.com/smallnest/goframe)](https://goreportcard.com/report/github.com/smallnest/goframe) 5 | 6 | 7 | ### wrapped conn interface 8 | goframe contains one FrameConn interface and some concrete FrameConn implementations: 9 | 10 | ```go 11 | type FrameConn interface { 12 | ReadFrame() ([]byte, error) 13 | WriteFrame(p []byte) error 14 | Close() error 15 | Conn() net.Conn 16 | } 17 | ``` 18 | 19 | You can use `NewXXXXXXX` function to get a concrete FrameConn. 20 | 21 | When you want to send a frame, you use `WriteFrame`. 22 | When you want to receve a frame, you use `ReadFrame`. 23 | 24 | 25 | ### examples 26 | 27 | Currently I have implemented some FrameConns that has same formats to Netty frame decoders and encoders. 28 | So we can use Go and popular netty framework to communicate. I have created [some examples](https://github.com/smallnest/goframe/tree/master/_examples) to demonstrate it. 29 | 30 | Those examples contains client and server for both go and netty, so you can use any client and any server to start. 31 | 32 | 33 | ### concrete FrameConn implementations 34 | 35 | 1. **FixedLengthFrameConn**: each frame has fixed number of bytes. `ReadFrame` returns the fixed length bytes and `WriteFrame` can write `n * fixed length` bytes. 36 | 2. **LineBasedFrameConn**: split data with line separator (\n or \r\n). `WriteFrame` writes data p and appends "\r\n" 37 | 3. **DelimiterBasedFrameConn**: split data with a specific delimiter. 38 | 4. **lengthFieldBasedFrameConn**: it is a complex FrameConn. It contains several parameters and can produce many frame format. I has copy descriptions from [Netty javadoc](https://netty.io/4.1/api/io/netty/handler/codec/LengthFieldBasedFrameDecoder.html): 39 | 40 | Here are some decoder example that will give you the basic idea on which option does what. 41 | 42 | #### 2 bytes length field at offset 0, do not strip header 43 | 44 | The value of the length field in this example is 12 (0x0C) which represents the length of "HELLO, WORLD". By default, the decoder assumes that the length field represents the number of the bytes that follows the length field. Therefore, it can be decoded with the simplistic parameter combination. 45 | 46 | ``` 47 | lengthFieldOffset = 0 48 | lengthFieldLength = 2 49 | lengthAdjustment = 0 50 | initialBytesToStrip = 0 (= do not strip header) 51 | 52 | 53 | BEFORE DECODE (14 bytes) AFTER DECODE (14 bytes) 54 | +--------+----------------+ +--------+----------------+ 55 | | Length | Actual Content |----->| Length | Actual Content | 56 | | 0x000C | "HELLO, WORLD" | | 0x000C | "HELLO, WORLD" | 57 | +--------+----------------+ +--------+----------------+ 58 | ``` 59 | 60 | #### 2 bytes length field at offset 0, strip header 61 | 62 | Because we can get the length of the content by calling ByteBuf.readableBytes(), you might want to strip the length field by specifying initialBytesToStrip. In this example, we specified 2, that is same with the length of the length field, to strip the first two bytes. 63 | 64 | ``` 65 | lengthFieldOffset = 0 66 | lengthFieldLength = 2 67 | lengthAdjustment = 0 68 | initialBytesToStrip = 2 (= the length of the Length field) 69 | 70 | BEFORE DECODE (14 bytes) AFTER DECODE (12 bytes) 71 | +--------+----------------+ +----------------+ 72 | | Length | Actual Content |----->| Actual Content | 73 | | 0x000C | "HELLO, WORLD" | | "HELLO, WORLD" | 74 | +--------+----------------+ +----------------+ 75 | ``` 76 | 77 | #### 2 bytes length field at offset 0, do not strip header, the length field represents the length of the whole message 78 | 79 | In most cases, the length field represents the length of the message body only, as shown in the previous examples. However, in some protocols, the length field represents the length of the whole message, including the message header. In such a case, we specify a non-zero lengthAdjustment. Because the length value in this example message is always greater than the body length by 2, we specify -2 as lengthAdjustment for compensation. 80 | 81 | ``` 82 | lengthFieldOffset = 0 83 | lengthFieldLength = 2 84 | lengthAdjustment = -2 (= the length of the Length field) 85 | initialBytesToStrip = 0 86 | 87 | BEFORE DECODE (14 bytes) AFTER DECODE (14 bytes) 88 | +--------+----------------+ +--------+----------------+ 89 | | Length | Actual Content |----->| Length | Actual Content | 90 | | 0x000E | "HELLO, WORLD" | | 0x000E | "HELLO, WORLD" | 91 | +--------+----------------+ +--------+----------------+ 92 | ``` 93 | 94 | #### 3 bytes length field at the end of 5 bytes header, do not strip header 95 | 96 | The following message is a simple variation of the first example. An extra header value is prepended to the message. lengthAdjustment is zero again because the decoder always takes the length of the prepended data into account during frame length calculation. 97 | 98 | ``` 99 | lengthFieldOffset = 2 (= the length of Header 1) 100 | lengthFieldLength = 3 101 | lengthAdjustment = 0 102 | initialBytesToStrip = 0 103 | 104 | BEFORE DECODE (17 bytes) AFTER DECODE (17 bytes) 105 | +----------+----------+----------------+ +----------+----------+----------------+ 106 | | Header 1 | Length | Actual Content |----->| Header 1 | Length | Actual Content | 107 | | 0xCAFE | 0x00000C | "HELLO, WORLD" | | 0xCAFE | 0x00000C | "HELLO, WORLD" | 108 | +----------+----------+----------------+ +----------+----------+----------------+ 109 | ``` 110 | 111 | #### 3 bytes length field at the beginning of 5 bytes header, do not strip header 112 | 113 | This is an advanced example that shows the case where there is an extra header between the length field and the message body. You have to specify a positive lengthAdjustment so that the decoder counts the extra header into the frame length calculation. 114 | 115 | ``` 116 | lengthFieldOffset = 0 117 | lengthFieldLength = 3 118 | lengthAdjustment = 2 (= the length of Header 1) 119 | initialBytesToStrip = 0 120 | 121 | BEFORE DECODE (17 bytes) AFTER DECODE (17 bytes) 122 | +----------+----------+----------------+ +----------+----------+----------------+ 123 | | Length | Header 1 | Actual Content |----->| Length | Header 1 | Actual Content | 124 | | 0x00000C | 0xCAFE | "HELLO, WORLD" | | 0x00000C | 0xCAFE | "HELLO, WORLD" | 125 | +----------+----------+----------------+ +----------+----------+----------------+ 126 | ``` 127 | 128 | #### 2 bytes length field at offset 1 in the middle of 4 bytes header, strip the first header field and the length field 129 | 130 | This is a combination of all the examples above. There are the prepended header before the length field and the extra header after the length field. The prepended header affects the lengthFieldOffset and the extra header affects the lengthAdjustment. We also specified a non-zero initialBytesToStrip to strip the length field and the prepended header from the frame. If you don't want to strip the prepended header, you could specify 0 for initialBytesToSkip. 131 | 132 | ``` 133 | lengthFieldOffset = 1 (= the length of HDR1) 134 | lengthFieldLength = 2 135 | lengthAdjustment = 1 (= the length of HDR2) 136 | initialBytesToStrip = 3 (= the length of HDR1 + LEN) 137 | 138 | BEFORE DECODE (16 bytes) AFTER DECODE (13 bytes) 139 | +------+--------+------+----------------+ +------+----------------+ 140 | | HDR1 | Length | HDR2 | Actual Content |----->| HDR2 | Actual Content | 141 | | 0xCA | 0x000C | 0xFE | "HELLO, WORLD" | | 0xFE | "HELLO, WORLD" | 142 | +------+--------+------+----------------+ +------+----------------+ 143 | ``` 144 | 145 | #### 2 bytes length field at offset 1 in the middle of 4 bytes header, strip the first header field and the length field, the length field represents the length of the whole message 146 | 147 | Let's give another twist to the previous example. The only difference from the previous example is that the length field represents the length of the whole message instead of the message body, just like the third example. We have to count the length of HDR1 and Length into lengthAdjustment. Please note that we don't need to take the length of HDR2 into account because the length field already includes the whole header length. 148 | 149 | ``` 150 | lengthFieldOffset = 1 151 | lengthFieldLength = 2 152 | lengthAdjustment = -3 (= the length of HDR1 + LEN, negative) 153 | initialBytesToStrip = 3 154 | 155 | BEFORE DECODE (16 bytes) AFTER DECODE (13 bytes) 156 | +------+--------+------+----------------+ +------+----------------+ 157 | | HDR1 | Length | HDR2 | Actual Content |----->| HDR2 | Actual Content | 158 | | 0xCA | 0x0010 | 0xFE | "HELLO, WORLD" | | 0xFE | "HELLO, WORLD" | 159 | +------+--------+------+----------------+ +------+----------------+ 160 | ``` 161 | 162 | For encoder, it prepends the length of the message. The length value is prepended as a binary form. 163 | For example, LengthFieldLength(2) will encode the following 12-bytes string: 164 | 165 | ``` 166 | +----------------+ 167 | | "HELLO, WORLD" | 168 | +----------------+ 169 | ``` 170 | 171 | into the following: 172 | 173 | ``` 174 | +--------+----------------+ 175 | + 0x000C | "HELLO, WORLD" | 176 | +--------+----------------+ 177 | ``` 178 | 179 | If you turned on the lengthIncludesLengthFieldLength flag in the EncoderConfig, the encoded data would look like the following (12 (original data) + 2 (prepended data) = 14 (0xE)): 180 | 181 | ``` 182 | +--------+----------------+ 183 | + 0x000E | "HELLO, WORLD" | 184 | +--------+----------------+ 185 | ``` 186 | 187 | 188 | -------------------------------------------------------------------------------- /_examples/goclient/client.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/binary" 5 | "fmt" 6 | "net" 7 | 8 | "github.com/smallnest/goframe" 9 | ) 10 | 11 | func main() { 12 | conn, err := net.Dial("tcp", "127.0.0.1:9981") 13 | if err != nil { 14 | panic(err) 15 | } 16 | defer conn.Close() 17 | 18 | encoderConfig := goframe.EncoderConfig{ 19 | ByteOrder: binary.BigEndian, 20 | LengthFieldLength: 4, 21 | LengthAdjustment: 0, 22 | LengthIncludesLengthFieldLength: false, 23 | } 24 | 25 | decoderConfig := goframe.DecoderConfig{ 26 | ByteOrder: binary.BigEndian, 27 | LengthFieldOffset: 0, 28 | LengthFieldLength: 4, 29 | LengthAdjustment: 0, 30 | InitialBytesToStrip: 4, 31 | } 32 | 33 | fc := goframe.NewLengthFieldBasedFrameConn(encoderConfig, decoderConfig, conn) 34 | err = fc.WriteFrame([]byte("hello")) 35 | if err != nil { 36 | panic(err) 37 | } 38 | err = fc.WriteFrame([]byte("world")) 39 | if err != nil { 40 | panic(err) 41 | } 42 | 43 | buf, err := fc.ReadFrame() 44 | if err != nil { 45 | panic(err) 46 | } 47 | fmt.Println("received: ", string(buf)) 48 | buf, err = fc.ReadFrame() 49 | if err != nil { 50 | panic(err) 51 | } 52 | fmt.Println("received: ", string(buf)) 53 | } 54 | -------------------------------------------------------------------------------- /_examples/goserver/server.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/binary" 5 | "fmt" 6 | "io" 7 | "net" 8 | 9 | "time" 10 | 11 | "github.com/smallnest/goframe" 12 | ) 13 | 14 | func main() { 15 | l, err := net.Listen("tcp", ":9981") 16 | if err != nil { 17 | panic(err) 18 | } 19 | defer l.Close() 20 | 21 | encoderConfig := goframe.EncoderConfig{ 22 | ByteOrder: binary.BigEndian, 23 | LengthFieldLength: 4, 24 | LengthAdjustment: 0, 25 | LengthIncludesLengthFieldLength: false, 26 | } 27 | 28 | decoderConfig := goframe.DecoderConfig{ 29 | ByteOrder: binary.BigEndian, 30 | LengthFieldOffset: 0, 31 | LengthFieldLength: 4, 32 | LengthAdjustment: 0, 33 | InitialBytesToStrip: 4, 34 | } 35 | 36 | for { 37 | conn, err := l.Accept() 38 | if err != nil { 39 | panic(err) 40 | } 41 | 42 | c := goframe.NewLengthFieldBasedFrameConn(encoderConfig, decoderConfig, conn) 43 | go func(conn goframe.FrameConn) { 44 | for { 45 | b, err := c.ReadFrame() 46 | if err != nil { 47 | if err == io.EOF { 48 | return 49 | } 50 | panic(err) 51 | } 52 | fmt.Println(string(b)) 53 | 54 | s := fmt.Sprintf("%d: %s", time.Now().UnixNano()/1e6, string(b)) 55 | c.WriteFrame([]byte(s)) 56 | } 57 | }(c) 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /_examples/netty/.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /_examples/netty/.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /_examples/netty/.idea/inspectionProfiles/Project_Default.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /_examples/netty/.idea/libraries/Maven__io_netty_netty_all_4_1_10_Final.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /_examples/netty/.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | Android 19 | 20 | 21 | Android > Lint > Correctness 22 | 23 | 24 | Android > Lint > Performance 25 | 26 | 27 | CorrectnessLintAndroid 28 | 29 | 30 | General 31 | 32 | 33 | Kotlin 34 | 35 | 36 | LintAndroid 37 | 38 | 39 | Maven 40 | 41 | 42 | Plugin DevKit 43 | 44 | 45 | XPath 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /_examples/netty/.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /_examples/netty/.idea/workspace.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 14 | 15 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 102 | 103 | 104 | 109 | 112 | 113 | 114 | 123 | 124 | 125 | 130 | 131 | 132 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 161 | 162 | 165 | 166 | 167 | 168 | 171 | 172 | 175 | 176 | 179 | 180 | 183 | 184 | 187 | 188 | 189 | 190 | 193 | 194 | 197 | 198 | 201 | 202 | 205 | 206 | 209 | 210 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 231 | 232 | 245 | 246 | 247 | 248 | 251 | 252 | 265 | 266 | 267 | 272 | 273 | 274 | 300 | 301 | 302 | 327 | 328 | 335 | 336 | 337 | 350 | 351 | 361 | 362 | 363 | 370 | 373 | 375 | 376 | 377 | 378 | 379 | 380 | 394 | 395 | 396 | 397 | 398 | 399 | 400 | 401 | 402 | 403 | 404 | 405 | 419 | 420 | 421 | 432 | 433 | 434 | 444 | 445 | 452 | 453 | 454 | 455 | 456 | 457 | 458 | 459 | 460 | 461 | 462 | 463 | 464 | 465 | 466 | 467 | 468 | 469 | 470 | 471 | 472 | 473 | 474 | 475 | 476 | 477 | 478 | 479 | 480 | 481 | 482 | 483 | 484 | 485 | 486 | 487 | 488 | 489 | 507 | 514 | 515 | 516 | 517 | 518 | 519 | 520 | 521 | 522 | 523 | 524 | 525 | 526 | 527 | 528 | 529 | 530 | 531 | 532 | 533 | 534 | 535 | 536 | 537 | 538 | 539 | 540 | 541 | 542 | 543 | 546 | 547 | 548 | 550 | 551 | 552 | 553 | 1494305032519 554 | 558 | 559 | 560 | 561 | 562 | 563 | 564 | 565 | 566 | 567 | 568 | 569 | 570 | 571 | 572 | 573 | 574 | 575 | 576 | 577 | 578 | 579 | 580 | 581 | 582 | 583 | 584 | 585 | 586 | 587 | 588 | 589 | 590 | 591 | 592 | 593 | 594 | 595 | 596 | 598 | 599 | 600 | 601 | 602 | 603 | 606 | 607 | 608 | 609 | 610 | 611 | 612 | 613 | 614 | 615 | 616 | 617 | 618 | 619 | 620 | 621 | 622 | 623 | 624 | 625 | 626 | 627 | 628 | 629 | 630 | 631 | 632 | 633 | 634 | 635 | 636 | 637 | 638 | 639 | 640 | 641 | 642 | 643 | 644 | 645 | 646 | 647 | 648 | 649 | 650 | 651 | 652 | 653 | 654 | 655 | 656 | 657 | 658 | 659 | 660 | 661 | 662 | 663 | 664 | 665 | 666 | 667 | 668 | 669 | 670 | 671 | 672 | 673 | 674 | 675 | 676 | 677 | 678 | 679 | 680 | 681 | 682 | 683 | 684 | 685 | 686 | 687 | 688 | 689 | 690 | 691 | 692 | 693 | 694 | 695 | 696 | 697 | 698 | 699 | 700 | 701 | 702 | 703 | 704 | 705 | 706 | 707 | 708 | 709 | 710 | 711 | 712 | 713 | 714 | 715 | 716 | 717 | 718 | 719 | 720 | 721 | 722 | 723 | 724 | 729 | 730 | 731 | 732 | 733 | 734 | No facets are configured 735 | 736 | 741 | 742 | 743 | 744 | 745 | 746 | scala-sdk-2.12.0 747 | 748 | 753 | 754 | 755 | 756 | 757 | 758 | 1.8 759 | 760 | 765 | 766 | 767 | 768 | 769 | 770 | netty 771 | 772 | 778 | 779 | 780 | 781 | 782 | 783 | 1.8 784 | 785 | 790 | 791 | 792 | 793 | 794 | 795 | 796 | 801 | 802 | 803 | 804 | 805 | 806 | -------------------------------------------------------------------------------- /_examples/netty/pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4.0.0 4 | 5 | com.colobu 6 | netty 7 | 1.0-SNAPSHOT 8 | jar 9 | 10 | netty 11 | http://maven.apache.org 12 | 13 | 14 | UTF-8 15 | 1.8 16 | 1.8 17 | 18 | 19 | 20 | 21 | io.netty 22 | netty-all 23 | 4.1.42.Final 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /_examples/netty/src/main/java/com/colobu/Client.java: -------------------------------------------------------------------------------- 1 | package com.colobu; 2 | 3 | import io.netty.bootstrap.Bootstrap; 4 | import io.netty.channel.*; 5 | import io.netty.channel.nio.NioEventLoopGroup; 6 | import io.netty.channel.socket.SocketChannel; 7 | import io.netty.channel.socket.nio.NioSocketChannel; 8 | import io.netty.handler.codec.LengthFieldBasedFrameDecoder; 9 | import io.netty.handler.codec.LengthFieldPrepender; 10 | import io.netty.handler.codec.string.StringDecoder; 11 | import io.netty.handler.codec.string.StringEncoder; 12 | 13 | public class Client { 14 | static final String HOST = System.getProperty("host", "127.0.0.1"); 15 | static final int PORT = Integer.parseInt(System.getProperty("port", "9981")); 16 | 17 | public static void main(String[] args) throws InterruptedException { 18 | EventLoopGroup group = new NioEventLoopGroup(); 19 | try { 20 | Bootstrap b = new Bootstrap(); 21 | b.group(group) 22 | .channel(NioSocketChannel.class) 23 | .option(ChannelOption.TCP_NODELAY, true) 24 | .handler(new ChannelInitializer() { 25 | @Override 26 | public void initChannel(SocketChannel ch) throws Exception { 27 | ChannelPipeline p = ch.pipeline(); 28 | 29 | p.addLast("frameDecoder", 30 | new LengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4)); 31 | p.addLast("frameEncoder", new LengthFieldPrepender(4)); 32 | p.addLast(new StringDecoder()); 33 | p.addLast(new StringEncoder()); 34 | 35 | //p.addLast(new LoggingHandler(LogLevel.INFO)); 36 | p.addLast(new ClientHandler()); 37 | } 38 | }); 39 | 40 | // Start the client. 41 | ChannelFuture f = b.connect(HOST, PORT).sync(); 42 | Channel ch = f.channel(); 43 | ch.writeAndFlush("hello"); 44 | ch.writeAndFlush("world"); 45 | 46 | // Wait until the connection is closed. 47 | f.channel().closeFuture().sync(); 48 | } finally { 49 | // Shut down the event loop to terminate all threads. 50 | group.shutdownGracefully(); 51 | } 52 | 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /_examples/netty/src/main/java/com/colobu/ClientHandler.java: -------------------------------------------------------------------------------- 1 | package com.colobu; 2 | 3 | 4 | import io.netty.channel.ChannelHandlerContext; 5 | import io.netty.channel.SimpleChannelInboundHandler; 6 | 7 | public class ClientHandler extends SimpleChannelInboundHandler { 8 | 9 | @Override 10 | protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception { 11 | System.out.println("received: " + msg); 12 | } 13 | 14 | @Override 15 | public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { 16 | cause.printStackTrace(); 17 | ctx.close(); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /_examples/netty/src/main/java/com/colobu/Server.java: -------------------------------------------------------------------------------- 1 | package com.colobu; 2 | 3 | import io.netty.bootstrap.ServerBootstrap; 4 | import io.netty.channel.*; 5 | import io.netty.channel.nio.NioEventLoopGroup; 6 | import io.netty.channel.socket.SocketChannel; 7 | import io.netty.channel.socket.nio.NioServerSocketChannel; 8 | import io.netty.handler.codec.LengthFieldBasedFrameDecoder; 9 | import io.netty.handler.codec.LengthFieldPrepender; 10 | import io.netty.handler.codec.string.StringDecoder; 11 | import io.netty.handler.codec.string.StringEncoder; 12 | 13 | public class Server { 14 | static final int PORT = Integer.parseInt(System.getProperty("port", "9981")); 15 | 16 | public static void main(String[] args) throws InterruptedException { 17 | // Configure the server. 18 | EventLoopGroup bossGroup = new NioEventLoopGroup(1); 19 | EventLoopGroup workerGroup = new NioEventLoopGroup(); 20 | try { 21 | ServerBootstrap b = new ServerBootstrap(); 22 | b.group(bossGroup, workerGroup) 23 | .channel(NioServerSocketChannel.class) 24 | .option(ChannelOption.SO_BACKLOG, 100) 25 | //.handler(new LoggingHandler(LogLevel.INFO)) 26 | .childHandler(new ChannelInitializer() { 27 | @Override 28 | public void initChannel(SocketChannel ch) throws Exception { 29 | ChannelPipeline p = ch.pipeline(); 30 | 31 | p.addLast("frameDecoder", 32 | new LengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4)); 33 | p.addLast("frameEncoder", new LengthFieldPrepender(4)); 34 | p.addLast(new StringDecoder()); 35 | p.addLast(new StringEncoder()); 36 | 37 | p.addLast(new ServerHandler()); 38 | } 39 | }); 40 | 41 | // Start the server. 42 | ChannelFuture f = b.bind(PORT).sync(); 43 | 44 | // Wait until the server socket is closed. 45 | f.channel().closeFuture().sync(); 46 | } finally { 47 | // Shut down all event loops to terminate all threads. 48 | bossGroup.shutdownGracefully(); 49 | workerGroup.shutdownGracefully(); 50 | } 51 | 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /_examples/netty/src/main/java/com/colobu/ServerHandler.java: -------------------------------------------------------------------------------- 1 | package com.colobu; 2 | 3 | import io.netty.channel.ChannelHandlerContext; 4 | import io.netty.channel.SimpleChannelInboundHandler; 5 | 6 | public class ServerHandler extends SimpleChannelInboundHandler { 7 | @Override 8 | protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception { 9 | System.out.println("received: " + msg); 10 | ctx.writeAndFlush(System.currentTimeMillis() + ":" + msg); 11 | } 12 | 13 | @Override 14 | public void channelReadComplete(ChannelHandlerContext ctx) { 15 | ctx.flush(); 16 | } 17 | 18 | @Override 19 | public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { 20 | // Close the connection when an exception is raised. 21 | cause.printStackTrace(); 22 | ctx.close(); 23 | } 24 | } 25 | 26 | -------------------------------------------------------------------------------- /delimiter_based_frameconn.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import ( 4 | "bufio" 5 | "net" 6 | "sync" 7 | ) 8 | 9 | type delimiterBasedFrameConn struct { 10 | delimiter byte 11 | c net.Conn 12 | r *bufio.Reader 13 | w *bufio.Writer 14 | rm sync.Mutex 15 | wm sync.Mutex 16 | } 17 | 18 | // NewDelimiterBasedFrameConn returns a Frame conn framed with delimiter. 19 | func NewDelimiterBasedFrameConn(delimiter byte, conn net.Conn) FrameConn { 20 | return &delimiterBasedFrameConn{ 21 | delimiter: delimiter, 22 | c: conn, 23 | r: bufio.NewReader(conn), 24 | w: bufio.NewWriter(conn), 25 | rm: sync.Mutex{}, 26 | wm: sync.Mutex{}, 27 | } 28 | } 29 | 30 | func (fc *delimiterBasedFrameConn) ReadFrame() ([]byte, error) { 31 | var ( 32 | isPrefix bool 33 | err error 34 | line, ln []byte 35 | ) 36 | 37 | fc.rm.Lock() 38 | defer fc.rm.Unlock() 39 | 40 | for isPrefix && err == nil { 41 | line, err = fc.r.ReadBytes(fc.delimiter) 42 | ln = append(ln, line...) 43 | if err != nil { 44 | return ln, err 45 | } 46 | } 47 | 48 | return ln, nil 49 | } 50 | 51 | func (fc *delimiterBasedFrameConn) WriteFrame(p []byte) error { 52 | fc.wm.Lock() 53 | defer fc.wm.Unlock() 54 | 55 | _, err := fc.w.Write(p) 56 | if err != nil { 57 | return err 58 | } 59 | err = fc.w.WriteByte(fc.delimiter) 60 | if err != nil { 61 | return err 62 | } 63 | fc.w.Flush() 64 | return nil 65 | } 66 | 67 | func (fc *delimiterBasedFrameConn) Close() error { 68 | return fc.c.Close() 69 | } 70 | 71 | func (fc *delimiterBasedFrameConn) Conn() net.Conn { 72 | return fc.c 73 | } 74 | -------------------------------------------------------------------------------- /error.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import "errors" 4 | 5 | var ( 6 | // ErrUnsupportedlength unsupported lengthFieldLength. 7 | ErrUnsupportedlength = errors.New("unsupported lengthFieldLength. (expected: 1, 2, 3, 4, or 8)") 8 | // ErrTooLessLength adjusted frame length is less than zero 9 | ErrTooLessLength = errors.New("Adjusted frame length is less than zero") 10 | // ErrUnexpectedFixedLength is not unexpected fixed length for writting fixed length frames. 11 | ErrUnexpectedFixedLength = errors.New("Unexpected fixed length") 12 | ) 13 | -------------------------------------------------------------------------------- /fixed_length_frameconn.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import ( 4 | "bufio" 5 | "io" 6 | "net" 7 | "sync" 8 | ) 9 | 10 | type fixedLengthFrameConn struct { 11 | frameLength int 12 | c net.Conn 13 | r *bufio.Reader 14 | w *bufio.Writer 15 | rm sync.Mutex 16 | wm sync.Mutex 17 | } 18 | 19 | // NewFixedLengthFrameConn returns a fixed length Frame conn. 20 | func NewFixedLengthFrameConn(frameLength int, conn net.Conn) FrameConn { 21 | return &fixedLengthFrameConn{ 22 | frameLength: frameLength, 23 | c: conn, 24 | r: bufio.NewReader(conn), 25 | w: bufio.NewWriter(conn), 26 | rm: sync.Mutex{}, 27 | wm: sync.Mutex{}, 28 | } 29 | } 30 | func (fc *fixedLengthFrameConn) ReadFrame() ([]byte, error) { 31 | fc.rm.Lock() 32 | defer fc.rm.Unlock() 33 | buf := make([]byte, fc.frameLength) 34 | _, err := io.ReadFull(fc.r, buf) 35 | return buf, err 36 | } 37 | 38 | func (fc *fixedLengthFrameConn) WriteFrame(p []byte) error { 39 | fc.wm.Lock() 40 | defer fc.wm.Unlock() 41 | l := len(p) 42 | if l%fc.frameLength != 0 { 43 | return ErrUnexpectedFixedLength 44 | } 45 | 46 | for i := 0; i < l; i += fc.frameLength { 47 | _, err := fc.w.Write(p[i : i+fc.frameLength]) 48 | if err != nil { 49 | return err 50 | } 51 | } 52 | 53 | fc.w.Flush() 54 | return nil 55 | } 56 | 57 | func (fc *fixedLengthFrameConn) Close() error { 58 | return fc.c.Close() 59 | } 60 | 61 | func (fc *fixedLengthFrameConn) Conn() net.Conn { 62 | return fc.c 63 | } 64 | -------------------------------------------------------------------------------- /frame.go: -------------------------------------------------------------------------------- 1 | //refer to: 2 | // 1. https://github.com/nickpisacane/framedconn 3 | // 2. https://github.com/netty/netty/blob/eb7f751ba519cbcab47d640cd18757f09d077b55/codec/src/main/java/io/netty/handler/codec/LengthFieldBasedFrameDecoder.java 4 | // 3. https://github.com/netty/netty/blob/eb7f751ba519cbcab47d640cd18757f09d077b55/codec/src/main/java/io/netty/handler/codec/LengthFieldPrepender.java 5 | package goframe 6 | 7 | import ( 8 | "net" 9 | ) 10 | 11 | // FrameConn is a conn that can send and receive framed data. 12 | type FrameConn interface { 13 | // Reads a "frame" from the connection. 14 | ReadFrame() ([]byte, error) 15 | 16 | // Writes a "frame" to the connection. 17 | WriteFrame(p []byte) error 18 | 19 | // Closes the connections, truncates any buffers. 20 | Close() error 21 | 22 | // Returns the underlying connection. 23 | Conn() net.Conn 24 | } 25 | -------------------------------------------------------------------------------- /frame_test.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import ( 4 | "io" 5 | "log" 6 | "net" 7 | 8 | "encoding/binary" 9 | "fmt" 10 | "testing" 11 | "time" 12 | ) 13 | 14 | func TestFrameConn(t *testing.T) { 15 | //server 16 | l, err := net.Listen("tcp", ":9981") 17 | if err != nil { 18 | t.Fatal(err) 19 | } 20 | defer l.Close() 21 | 22 | encoderConfig := EncoderConfig{ 23 | ByteOrder: binary.BigEndian, 24 | LengthFieldLength: 2, 25 | LengthAdjustment: 0, 26 | LengthIncludesLengthFieldLength: false, 27 | } 28 | 29 | decoderConfig := DecoderConfig{ 30 | ByteOrder: binary.BigEndian, 31 | LengthFieldLength: 2, 32 | LengthFieldOffset: 0, 33 | LengthAdjustment: 0, 34 | InitialBytesToStrip: 2, 35 | } 36 | 37 | go func() { 38 | for { 39 | conn, err := l.Accept() 40 | if err != nil { 41 | log.Println(err) 42 | return 43 | } 44 | 45 | c := NewLengthFieldBasedFrameConn(encoderConfig, decoderConfig, conn) 46 | go func(conn FrameConn) { 47 | for { 48 | b, err := c.ReadFrame() 49 | if err != nil { 50 | if err == io.EOF { 51 | return 52 | } 53 | } 54 | fmt.Println(string(b)) 55 | } 56 | }(c) 57 | } 58 | 59 | }() 60 | 61 | conn, err := net.Dial("tcp", "127.0.0.1:9981") 62 | if err != nil { 63 | t.Fatal(err) 64 | } 65 | defer conn.Close() 66 | 67 | fc := NewLengthFieldBasedFrameConn(encoderConfig, decoderConfig, conn) 68 | fc.WriteFrame([]byte("hello")) 69 | fc.WriteFrame([]byte("world")) 70 | 71 | time.Sleep(1 * time.Second) 72 | } 73 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/smallnest/goframe 2 | 3 | go 1.13 4 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/smallnest/goframe/2eb334f3021be84d99541aab8375abf27caa39e5/go.sum -------------------------------------------------------------------------------- /length_field_based_frameconn.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import ( 4 | "bufio" 5 | "encoding/binary" 6 | "fmt" 7 | "net" 8 | "sync" 9 | ) 10 | 11 | type lengthFieldBasedFrameConn struct { 12 | encoderConfig EncoderConfig 13 | decoderConfig DecoderConfig 14 | c net.Conn 15 | r *bufio.Reader 16 | w *bufio.Writer 17 | rm sync.Mutex 18 | wm sync.Mutex 19 | } 20 | 21 | // EncoderConfig config for encoder. 22 | type EncoderConfig struct { 23 | // ByteOrder is the ByteOrder of the length field. 24 | ByteOrder binary.ByteOrder 25 | // LengthFieldLength is the length of the length field. 26 | LengthFieldLength int 27 | // LengthAdjustment is the compensation value to add to the value of the length field 28 | LengthAdjustment int 29 | // LengthIncludesLengthFieldLength is true, the length of the prepended length field is added to the value of the prepended length field 30 | LengthIncludesLengthFieldLength bool 31 | } 32 | 33 | // DecoderConfig config for decoder. 34 | type DecoderConfig struct { 35 | // ByteOrder is the ByteOrder of the length field. 36 | ByteOrder binary.ByteOrder 37 | // LengthFieldOffset is the offset of the length field 38 | LengthFieldOffset int 39 | // LengthFieldLength is the length of the length field 40 | LengthFieldLength int 41 | // LengthAdjustment is the compensation value to add to the value of the length field 42 | LengthAdjustment int 43 | // InitialBytesToStrip is the number of first bytes to strip out from the decoded frame 44 | InitialBytesToStrip int 45 | } 46 | 47 | // NewLengthFieldBasedFrameConn returns a wrapped Frame conn based on the length field. 48 | // It is the go implementation of netty LengthFieldBasedFrameecoder and LengthFieldPrepender. 49 | // you can see javadoc of them to learn more details. 50 | func NewLengthFieldBasedFrameConn(encoderConfig EncoderConfig, decoderConfig DecoderConfig, conn net.Conn) FrameConn { 51 | return &lengthFieldBasedFrameConn{ 52 | encoderConfig: encoderConfig, 53 | decoderConfig: decoderConfig, 54 | c: conn, 55 | r: bufio.NewReader(conn), 56 | w: bufio.NewWriter(conn), 57 | rm: sync.Mutex{}, 58 | wm: sync.Mutex{}, 59 | } 60 | } 61 | 62 | func (fc *lengthFieldBasedFrameConn) ReadFrame() ([]byte, error) { 63 | var header []byte 64 | var err error 65 | 66 | fc.rm.Lock() 67 | defer fc.rm.Unlock() 68 | 69 | if fc.decoderConfig.LengthFieldOffset > 0 { //discard header(offset) 70 | header, err = ReadN(fc.r, fc.decoderConfig.LengthFieldOffset) 71 | if err != nil { 72 | return nil, err 73 | } 74 | } 75 | 76 | lenBuf, frameLength, err := fc.getUnadjustedFrameLength() 77 | if err != nil { 78 | return nil, err 79 | } 80 | 81 | // real message length 82 | msgLength := int(frameLength) + fc.decoderConfig.LengthAdjustment 83 | msg, err := ReadN(fc.r, msgLength) 84 | if err != nil { 85 | return nil, err 86 | } 87 | 88 | fullMessage := make([]byte, len(header)+len(lenBuf)+msgLength) 89 | copy(fullMessage, header) 90 | copy(fullMessage[len(header):], lenBuf) 91 | copy(fullMessage[len(header)+len(lenBuf):], msg) 92 | 93 | return fullMessage[fc.decoderConfig.InitialBytesToStrip:], nil 94 | } 95 | 96 | func (fc *lengthFieldBasedFrameConn) getUnadjustedFrameLength() (lenBuf []byte, n uint64, err error) { 97 | switch fc.decoderConfig.LengthFieldLength { 98 | case 1: 99 | b, err := fc.r.ReadByte() 100 | return []byte{b}, uint64(b), err 101 | case 2: 102 | lenBuf, err = ReadN(fc.r, 2) 103 | if err != nil { 104 | return nil, 0, err 105 | } 106 | return lenBuf, uint64(fc.decoderConfig.ByteOrder.Uint16(lenBuf)), nil 107 | case 3: 108 | lenBuf, err = ReadN(fc.r, 3) 109 | if err != nil { 110 | return nil, 0, err 111 | } 112 | return lenBuf, readUint24(fc.decoderConfig.ByteOrder, lenBuf), nil 113 | case 4: 114 | lenBuf, err = ReadN(fc.r, 4) 115 | if err != nil { 116 | return nil, 0, err 117 | } 118 | return lenBuf, uint64(fc.decoderConfig.ByteOrder.Uint32(lenBuf)), nil 119 | case 8: 120 | lenBuf, err = ReadN(fc.r, 8) 121 | if err != nil { 122 | return nil, 0, err 123 | } 124 | return lenBuf, fc.decoderConfig.ByteOrder.Uint64(lenBuf), nil 125 | default: 126 | return nil, 0, ErrUnsupportedlength 127 | } 128 | } 129 | 130 | func readUint24(byteOrder binary.ByteOrder, b []byte) uint64 { 131 | _ = b[2] 132 | if byteOrder == binary.LittleEndian { 133 | return uint64(b[0]) | uint64(b[1])<<8 | uint64(b[2])<<16 134 | } 135 | 136 | return uint64(b[2]) | uint64(b[1])<<8 | uint64(b[0])<<16 137 | } 138 | 139 | func (fc *lengthFieldBasedFrameConn) WriteFrame(p []byte) error { 140 | length := len(p) + fc.encoderConfig.LengthAdjustment 141 | if fc.encoderConfig.LengthIncludesLengthFieldLength { 142 | length += fc.encoderConfig.LengthFieldLength 143 | } 144 | 145 | if length < 0 { 146 | return ErrTooLessLength 147 | } 148 | 149 | var err error 150 | fc.wm.Lock() 151 | defer fc.wm.Unlock() 152 | 153 | switch fc.encoderConfig.LengthFieldLength { 154 | case 1: 155 | if length >= 256 { 156 | return fmt.Errorf("length does not fit into a byte: %d", length) 157 | } 158 | err = fc.w.WriteByte(byte(length)) 159 | if err != nil { 160 | return err 161 | } 162 | case 2: 163 | if length >= 65536 { 164 | return fmt.Errorf("length does not fit into a short integer: %d", length) 165 | } 166 | buf := make([]byte, 2) 167 | fc.encoderConfig.ByteOrder.PutUint16(buf, uint16(length)) 168 | _, err = fc.w.Write(buf) 169 | if err != nil { 170 | return err 171 | } 172 | case 3: 173 | if length >= 16777216 { 174 | return fmt.Errorf("length does not fit into a medium integer: %d", length) 175 | } 176 | buf := writeUint24(fc.encoderConfig.ByteOrder, length) 177 | _, err = fc.w.Write(buf) 178 | if err != nil { 179 | return err 180 | } 181 | case 4: 182 | buf := make([]byte, 4) 183 | fc.encoderConfig.ByteOrder.PutUint32(buf, uint32(length)) 184 | _, err = fc.w.Write(buf) 185 | if err != nil { 186 | return err 187 | } 188 | case 8: 189 | buf := make([]byte, 8) 190 | fc.encoderConfig.ByteOrder.PutUint64(buf, uint64(length)) 191 | _, err = fc.w.Write(buf) 192 | if err != nil { 193 | return err 194 | } 195 | default: 196 | return ErrUnsupportedlength 197 | } 198 | 199 | _, err = fc.w.Write(p) 200 | fc.w.Flush() 201 | return err 202 | } 203 | 204 | func writeUint24(byteOrder binary.ByteOrder, v int) []byte { 205 | b := make([]byte, 3) 206 | if byteOrder == binary.LittleEndian { 207 | b[0] = byte(v) 208 | b[1] = byte(v >> 8) 209 | b[2] = byte(v >> 16) 210 | } else { 211 | b[2] = byte(v) 212 | b[1] = byte(v >> 8) 213 | b[0] = byte(v >> 16) 214 | } 215 | return b 216 | } 217 | 218 | func (fc *lengthFieldBasedFrameConn) Close() error { 219 | return fc.c.Close() 220 | } 221 | 222 | func (fc *lengthFieldBasedFrameConn) Conn() net.Conn { 223 | return fc.c 224 | } 225 | -------------------------------------------------------------------------------- /line_based_frameconn.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import ( 4 | "bufio" 5 | "net" 6 | ) 7 | 8 | var ( 9 | // CRLFBytes is a const bytes for crlf. 10 | CRLFBytes = []byte("\n") 11 | ) 12 | 13 | type lineBasedFrameConn struct { 14 | c net.Conn 15 | r *bufio.Reader 16 | w *bufio.Writer 17 | } 18 | 19 | // NewLineBasedFrameConn returns a line based Frame conn. 20 | func NewLineBasedFrameConn(conn net.Conn) FrameConn { 21 | return &lineBasedFrameConn{ 22 | c: conn, 23 | r: bufio.NewReader(conn), 24 | w: bufio.NewWriter(conn), 25 | } 26 | } 27 | 28 | func (fc *lineBasedFrameConn) ReadFrame() ([]byte, error) { 29 | // var ( 30 | // isPrefix bool 31 | // err error 32 | // line, ln []byte 33 | // ) 34 | 35 | // for isPrefix && err == nil { 36 | // line, isPrefix, err = fc.r.ReadLine() 37 | // ln = append(ln, line...) 38 | // if err != nil { 39 | // return ln, err 40 | // } 41 | // } 42 | 43 | data, err := fc.r.ReadBytes('\n') 44 | if err == nil && data[len(data)-1] == '\n' { 45 | data = data[:len(data)-1] 46 | } 47 | 48 | return data, err 49 | } 50 | 51 | func (fc *lineBasedFrameConn) WriteFrame(p []byte) error { 52 | _, err := fc.w.Write(p) 53 | if err != nil { 54 | return err 55 | } 56 | _, err = fc.w.Write(CRLFBytes) 57 | if err != nil { 58 | return err 59 | } 60 | fc.w.Flush() 61 | return nil 62 | } 63 | 64 | func (fc *lineBasedFrameConn) Close() error { 65 | return fc.c.Close() 66 | } 67 | 68 | func (fc *lineBasedFrameConn) Conn() net.Conn { 69 | return fc.c 70 | } 71 | -------------------------------------------------------------------------------- /util.go: -------------------------------------------------------------------------------- 1 | package goframe 2 | 3 | import "io" 4 | 5 | // ReadN reads n bytes 6 | func ReadN(r io.Reader, n int) ([]byte, error) { 7 | buf := make([]byte, n) 8 | _, err := io.ReadFull(r, buf) 9 | return buf, err 10 | } 11 | --------------------------------------------------------------------------------