deadline_data.go

   1 //
   2 // Copyright © 2017 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, 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 import "time"
  20
  21 /*
  22         ExpiredNotification is a callback function, provided by the client
  23         and called when a deadline expires.  The err parameter will contain
  24         the actual expired error.  The rw parameter will be true if
  25         the notification is for a write, and false otherwise.
  26 */
  27 type ExpiredNotification func(err error, rw bool)
  28
  29 /*
  30         DeadlineData controls the use of deadlines in network I/O.
  31 */
  32 type deadlineData struct {
  33         wde  bool          // Write deadline data enabled
  34         wdld time.Duration // Write deadline duration
  35         wds  bool          // True if write duration has been set
  36         //
  37         dlnotify ExpiredNotification
  38         dns      bool // True if dlnotify has been set
  39         //
  40         rde  bool          // Read deadline data enabled
  41         rdld time.Duration // Read deadline duration
  42         rds  bool          // True if read duration has been set
  43 }
  44
  45 /*
  46         WriteDeadline sets the write deadline duration.
  47 */
  48 func (c *Connection) WriteDeadline(d time.Duration) {
  49         c.log("Write Deadline", d)
  50         c.dld.wdld = d
  51         c.dld.wds = true
  52 }
  53
  54 /*
  55         EnableWriteDeadline enables/disables the use of write deadlines.
  56 */
  57 func (c *Connection) EnableWriteDeadline(e bool) {
  58         c.log("Enable Write Deadline", e)
  59         c.dld.wde = e
  60 }
  61
  62 /*
  63         ExpiredNotification sets the expired notification callback function.
  64 */
  65 func (c *Connection) ExpiredNotification(enf ExpiredNotification) {
  66         c.log("Set ExpiredNotification")
  67         c.dld.dlnotify = enf
  68         c.dld.dns = true
  69 }
  70
  71 /*
  72         IsWriteDeadlineEnabled returns the current value of write deadline
  73         enablement.
  74 */
  75 func (c *Connection) IsWriteDeadlineEnabled() bool {
  76         return c.dld.wde
  77 }
  78
  79 /*
  80         ReadDeadline sets the write deadline duration.
  81 */
  82 func (c *Connection) ReadDeadline(d time.Duration) {
  83         c.log("Read Deadline", d)
  84         c.dld.rdld = d
  85         c.dld.rds = true
  86 }
  87
  88 /*
  89         EnableReadDeadline enables/disables the use of read deadlines.
  90 */
  91 func (c *Connection) EnableReadDeadline(e bool) {
  92         c.log("Enable Read Deadline", e)
  93         c.dld.rde = e
  94 }
  95
  96 /*
  97         IsReadDeadlineEnabled returns the current value of write deadline
  98         enablement.
  99 */
 100 func (c *Connection) IsReadDeadlineEnabled() bool {
 101         return c.dld.rde
 102 }