//
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//

package util

import (
    `fmt`
    `github.com/apache/pulsar-client-go/pkg/pb`
)

// NewUnexpectedErrMsg instantiates an ErrUnexpectedMsg error.
// Optionally provide a list of IDs associated with the message
// for additional context in the error message.
func NewUnexpectedErrMsg(msgType pb.BaseCommand_Type, ids ...interface{}) *UnexpectedErrMsg {
    return &UnexpectedErrMsg{
        msgType: msgType,
        ids:     ids,
    }
}

// UnexpectedErrMsg is returned when an unexpected
// message is received.
type UnexpectedErrMsg struct {
    msgType pb.BaseCommand_Type
    ids     []interface{}
}

// Error satisfies the error interface.
func (e *UnexpectedErrMsg) Error() string {
    msg := fmt.Sprintf("received unexpected message of type %q", e.msgType.String())
    for _, id := range e.ids {
        msg += fmt.Sprintf(" id=%v", id)
    }
    return msg
}