Optimize socketclient adapter and add various code improvements
[govpp.git] / codec / msg_codec.go
index 9d3f614..3f60cae 100644 (file)
@@ -20,8 +20,9 @@ import (
        "fmt"
        "reflect"
 
-       "git.fd.io/govpp.git/api"
        "github.com/lunixbochs/struc"
+
+       "git.fd.io/govpp.git/api"
 )
 
 // MsgCodec provides encoding and decoding functionality of `api.Message` structs into/from
@@ -53,24 +54,32 @@ type VppOtherHeader struct {
 }
 
 // EncodeMsg encodes provided `Message` structure into its binary-encoded data representation.
-func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) ([]byte, error) {
+func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) (data []byte, err error) {
        if msg == nil {
                return nil, errors.New("nil message passed in")
        }
 
+       // try to recover panic which might possibly occur in struc.Pack call
+       defer func() {
+               if r := recover(); r != nil {
+                       var ok bool
+                       if err, ok = r.(error); !ok {
+                               err = fmt.Errorf("%v", r)
+                       }
+                       err = fmt.Errorf("panic occurred during encoding message %s: %v", msg.GetMessageName(), err)
+               }
+       }()
+
        var header interface{}
 
        // encode message header
        switch msg.GetMessageType() {
        case api.RequestMessage:
                header = &VppRequestHeader{VlMsgID: msgID}
-
        case api.ReplyMessage:
                header = &VppReplyHeader{VlMsgID: msgID}
-
        case api.EventMessage:
                header = &VppEventHeader{VlMsgID: msgID}
-
        default:
                header = &VppOtherHeader{VlMsgID: msgID}
        }
@@ -79,13 +88,13 @@ func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) ([]byte, error) {
 
        // encode message header
        if err := struc.Pack(buf, header); err != nil {
-               return nil, fmt.Errorf("unable to encode message header: %v, error %v", header, err)
+               return nil, fmt.Errorf("failed to encode message header: %+v, error: %v", header, err)
        }
 
        // encode message content
        if reflect.TypeOf(msg).Elem().NumField() > 0 {
                if err := struc.Pack(buf, msg); err != nil {
-                       return nil, fmt.Errorf("unable to encode message data: %v, error %v", header, err)
+                       return nil, fmt.Errorf("failed to encode message data: %+v, error: %v", data, err)
                }
        }
 
@@ -93,24 +102,32 @@ func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) ([]byte, error) {
 }
 
 // DecodeMsg decodes binary-encoded data of a message into provided `Message` structure.
-func (*MsgCodec) DecodeMsg(data []byte, msg api.Message) error {
+func (*MsgCodec) DecodeMsg(data []byte, msg api.Message) (err error) {
        if msg == nil {
                return errors.New("nil message passed in")
        }
 
+       // try to recover panic which might possibly occur
+       defer func() {
+               if r := recover(); r != nil {
+                       var ok bool
+                       if err, ok = r.(error); !ok {
+                               err = fmt.Errorf("%v", r)
+                       }
+                       err = fmt.Errorf("panic occurred during decoding message %s: %v", msg.GetMessageName(), err)
+               }
+       }()
+
        var header interface{}
 
        // check which header is expected
        switch msg.GetMessageType() {
        case api.RequestMessage:
                header = new(VppRequestHeader)
-
        case api.ReplyMessage:
                header = new(VppReplyHeader)
-
        case api.EventMessage:
                header = new(VppEventHeader)
-
        default:
                header = new(VppOtherHeader)
        }
@@ -118,13 +135,13 @@ func (*MsgCodec) DecodeMsg(data []byte, msg api.Message) error {
        buf := bytes.NewReader(data)
 
        // decode message header
-       if err := struc.Unpack(buf, header); err != nil {
-               return fmt.Errorf("unable to decode message header: %+v, error %v", data, err)
+       if err = struc.Unpack(buf, header); err != nil {
+               return fmt.Errorf("failed to decode message header: %+v, error: %v", header, err)
        }
 
        // decode message content
        if err := struc.Unpack(buf, msg); err != nil {
-               return fmt.Errorf("unable to decode message data: %+v, error %v", data, err)
+               return fmt.Errorf("failed to decode message data: %+v, error: %v", data, err)
        }
 
        return nil