Easy Simple Network Library  0.3.7
All Classes Functions Modules
MessageCodec.h
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of "esnetwork" library.
4 It is licensed under the terms of the BSD license.
5 For the latest info, see http://esnetwork.sourceforge.net
6 
7 Copyright (c) 2012-2013 Lin Jia Jun (Joe Lam)
8 All rights reserved.
9 
10 Redistribution and use in source and binary forms, with or without
11 modification, are permitted provided that the following conditions are met:
12 
13 1. Redistributions of source code must retain the above copyright notice, this
14  list of conditions and the following disclaimer.
15 2. Redistributions in binary form must reproduce the above copyright notice,
16  this list of conditions and the following disclaimer in the documentation
17  and/or other materials provided with the distribution.
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 -----------------------------------------------------------------------------
30 */
31 
32 #ifndef _ESN_MESSAGECODEC_H_
33 #define _ESN_MESSAGECODEC_H_
34 
35 #include "IoFilter.h"
36 
37 namespace esnlib
38 {
39 
41 class MessageCodec : public IoFilter
42 {
43 public:
44 
45  enum
46  {
47  STATE_WAIT_FOR_HEADER = 0,
48  STATE_WAIT_FOR_BODY = 1
49  };
50 
52  MessageCodec();
53 
57  explicit MessageCodec(int headerSize);
58 
63  MessageCodec(int headerSize, int bodySizePos);
64 
70  MessageCodec(int headerSize, int bodySizePos, int bodySizeLength);
71 
78  MessageCodec(int headerSize, int bodySizePos, int bodySizeLength, int maxBodySize);
79 
81  virtual ~MessageCodec();
82 
89  virtual bool Extract(SessionPtr session, IoBufferPtr data, std::vector<IoBufferPtr>& readylist);
90 
96  virtual IoBufferPtr Encode(SessionPtr session, void* data);
97 
103  virtual void* Decode(SessionPtr session, IoBufferPtr data);
104 
105 protected:
106 private:
107 
108  int m_headersize;
109  int m_bodysizepos;
110  int m_bodysizelen;
111  int m_maxbodysize;
112 
113 };
114 
115 typedef boost::shared_ptr<MessageCodec> MessageCodecPtr;
116 
117 }
118 
119 #endif // MESSAGECODEC_H
120 
virtual void * Decode(SessionPtr session, IoBufferPtr data)
Common Message Codec Filter class, a filter who can extract a common message(format: header + body) f...
Definition: MessageCodec.h:41
virtual bool Extract(SessionPtr session, IoBufferPtr data, std::vector< IoBufferPtr > &readylist)
virtual ~MessageCodec()
Destructor function.
virtual IoBufferPtr Encode(SessionPtr session, void *data)
Definition: Buffer.h:37
IO Filter class (interface)
Definition: IoFilter.h:43
MessageCodec()
Constructor function.