packet

lib/message/pingreq.go

@@ -0,0 +1,34 @@
+// Copyright (c) 2014 The SurgeMQ Authors. All rights reserved.
+//
+// Licensed 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 message
+
+// The PINGREQ Packet is sent from a Client to the Server. It can be used to:
+// 1. Indicate to the Server that the Client is alive in the absence of any other
+//    Control Packets being sent from the Client to the Server.
+// 2. Request that the Server responds to confirm that it is alive.
+// 3. Exercise the network to indicate that the Network Connection is active.
+type PingreqMessage struct {
+	DisconnectMessage
+}
+
+var _ Message = (*PingreqMessage)(nil)
+
+// NewPingreqMessage creates a new PINGREQ message.
+func NewPingreqMessage() *PingreqMessage {
+	msg := &PingreqMessage{}
+	msg.SetType(PINGREQ)
+
+	return msg
+}