Equity
Bitcoin Protocol Library
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Network::AlertMessage Class Reference

An alert message. More...

#include <AlertMessage.h>

Inheritance diagram for Network::AlertMessage:
Network::Message P2p::Serializable

Public Member Functions

 AlertMessage (std::vector< uint8_t > const &message)
 
 AlertMessage (uint8_t const *&in, size_t &size)
 
Overrides Serializable
virtual void serialize (std::vector< uint8_t > &out) const override
 
virtual json toJson () const override
 
- Public Member Functions inherited from Network::Message
 Message (char const *type)
 
std::string type () const
 Returns the type.
 

Public Attributes

std::vector< uint8_t > message_
 The raw alert message data.
 

Static Public Attributes

static char const TYPE [] = "alert"
 Message type.
 

Detailed Description

An alert message.

An alert is sent between nodes to send a general notification message throughout the network. If the alert can be confirmed with the signature as having come from the core development group of the Bitcoin software, the message is suggested to be displayed for end-users. Attempts to perform transactions, particularly automated transactions through the client, are suggested to be halted. The text in the Message string should be relayed to log files and any user interfaces.

Constructor & Destructor Documentation

AlertMessage::AlertMessage ( std::vector< uint8_t > const &  message)
Parameters
messagemessage to send
AlertMessage::AlertMessage ( uint8_t const *&  in,
size_t &  size 
)
Parameters
[in,out]inpointer to the next byte to deserialize
[in,out]sizenumber of bytes remaining in the serialized stream

The documentation for this class was generated from the following files: