FMessageAddressBook Class Reference

#include <MessageAddressBook.h>

Public Member Functions
	FMessageAddressBook ()
	~FMessageAddressBook ()
void	Add (const FMessageAddress &Address, const FGuid &NodeId)
void	Clear ()
bool	Contains (const FMessageAddress &Address)
TArray< FGuid >	GetNodesFor (const TArray< FMessageAddress > &Addresses)
void	RemoveAll (TArray< FMessageAddress > &OutRemovedAddresses)
void	RemoveNode (const FGuid &NodeId, TArray< FMessageAddress > &OutRemovedAddresses)

Detailed Description

Implements an address book that maps message addresses to remote nodes.

Constructor & Destructor Documentation

FMessageAddressBook()

FMessageAddressBook::FMessageAddressBook ( )

inline

Default constructor.

~FMessageAddressBook()

FMessageAddressBook::~FMessageAddressBook ( )

inline

Destructor.

Member Function Documentation

Add()

void FMessageAddressBook::Add ( const FMessageAddress &  Address, const FGuid &  NodeId  )

inline

Adds an address to the address book.

@Address The message address to add. @NodeId The identifier of the remote node that handles the message address.

Clear()

void FMessageAddressBook::Clear ( )

inline

Clears the address book.

Contains()

bool FMessageAddressBook::Contains ( const FMessageAddress &  Address )

inline

Checks whether this address book contains the given address.

Parameters

Address

The address to check.

Returns

true if the address is known, false otherwise.

GetNodesFor()

TArray< FGuid > FMessageAddressBook::GetNodesFor ( const TArray< FMessageAddress > &  Addresses )

inline

Gets the remote node identifiers for the specified list of message addresses.

Parameters

Addresses

The address list to retrieve the node identifiers for.

Returns

The list of node identifiers.

RemoveAll()

void FMessageAddressBook::RemoveAll ( TArray< FMessageAddress > &  OutRemovedAddresses )

inline

Removes all known message addresses.

To remove only the addresses for a specific remote node, use RemoveNode(). If you are not interested in the removed addresses, use Clear() instead.

Parameters

OutRemovedRecipients

Will hold a list of recipients that were removed.

See also

Clear, RemoveNode

RemoveNode()

void FMessageAddressBook::RemoveNode ( const FGuid &  NodeId, TArray< FMessageAddress > &  OutRemovedAddresses  )

inline

Removes all known message addresses for the specified remote node identifier.

Parameters

NodeId	The identifier of the remote node to remove.
OutRemovedRecipients	Will hold a list of recipients that were removed.

See also

Clear, RemoveAllNodes

---

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

• Engine/Source/Runtime/Messaging/Private/Bridge/MessageAddressBook.h