abort.go

   1 //
   2 // Copyright © 2011-2019 Guy M. Allard
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the "License");
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 package stompngo
  18
  19 /*
  20         Abort a STOMP transaction.
  21
  22         Headers MUST contain a "transaction" header key
  23         with a value that is not an empty string.
  24
  25         Example:
  26                 h := stompngo.Headers{stompngo.HK_TRANSACTION, "transaction-id1"}
  27                 e := c.Abort(h)
  28                 if e != nil {
  29                         // Do something sane ...
  30                 }
  31 */
  32 func (c *Connection) Abort(h Headers) error {
  33         c.log(ABORT, "start", h)
  34         if !c.isConnected() {
  35                 return ECONBAD
  36         }
  37         // We must have a transaction header here
  38         if _, ok := h.Contains(HK_TRANSACTION); !ok {
  39                 return EREQTIDABT
  40         }
  41         // And it must not be empty
  42         if h.Value(HK_TRANSACTION) == "" {
  43                 return ETIDABTEMT
  44         }
  45         e := c.transmitCommon(ABORT, h) // transmitCommon Clones() the headers
  46         c.log(ABORT, "end", h)
  47         return e
  48 }