Skip to content

Commit

Permalink
Remove prefix kSendFlag_ from enum class SendMessageFlag and kExchang…
Browse files Browse the repository at this point in the history
…eFlag_ from ExFlagValues (#4323)
  • Loading branch information
yufengwangca authored Jan 12, 2021
1 parent 6c94941 commit ab9dda6
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 30 deletions.
3 changes: 1 addition & 2 deletions src/app/CommandHandler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@ CHIP_ERROR CommandHandler::SendCommandResponse()

VerifyOrExit(mpExchangeCtx != NULL, err = CHIP_ERROR_INCORRECT_STATE);
err = mpExchangeCtx->SendMessage(Protocols::kProtocol_InteractionModel, kMsgType_InvokeCommandResponse,
std::move(mCommandMessageBuf),
Messaging::SendFlags(Messaging::SendMessageFlags::kSendFlag_None));
std::move(mCommandMessageBuf), Messaging::SendFlags(Messaging::SendMessageFlags::kNone));
SuccessOrExit(err);

MoveToState(kState_Sending);
Expand Down
2 changes: 1 addition & 1 deletion src/app/CommandSender.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ CHIP_ERROR CommandSender::SendCommandRequest(NodeId aNodeId)

err = mpExchangeCtx->SendMessage(Protocols::kProtocol_InteractionModel, kMsgType_InvokeCommandRequest,
std::move(mCommandMessageBuf),
Messaging::SendFlags(Messaging::SendMessageFlags::kSendFlag_ExpectResponse));
Messaging::SendFlags(Messaging::SendMessageFlags::kExpectResponse));
SuccessOrExit(err);
MoveToState(kState_Sending);

Expand Down
6 changes: 3 additions & 3 deletions src/messaging/ExchangeContext.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ CHIP_ERROR ExchangeContext::SendMessage(uint16_t protocolId, uint8_t msgType, Pa
state = mExchangeMgr->GetSessionMgr()->GetPeerConnectionState(mSecureSession);
VerifyOrExit(state != nullptr, err = CHIP_ERROR_NOT_CONNECTED);
if ((state->GetPeerAddress().GetTransportType() == Transport::Type::kUdp) && mReliableMessageContext.AutoRequestAck() &&
!sendFlags.Has(SendMessageFlags::kSendFlag_NoAutoRequestAck))
!sendFlags.Has(SendMessageFlags::kNoAutoRequestAck))
{
payloadHeader.SetNeedsAck(true);
}
Expand All @@ -126,7 +126,7 @@ CHIP_ERROR ExchangeContext::SendMessage(uint16_t protocolId, uint8_t msgType, Pa
}

// If a response message is expected...
if (sendFlags.Has(SendMessageFlags::kSendFlag_ExpectResponse))
if (sendFlags.Has(SendMessageFlags::kExpectResponse))
{
// Only one 'response expected' message can be outstanding at a time.
VerifyOrExit(!IsResponseExpected(), err = CHIP_ERROR_INCORRECT_STATE);
Expand Down Expand Up @@ -389,7 +389,7 @@ CHIP_ERROR ExchangeContext::HandleMessage(const PacketHeader & packetHeader, con

// An acknowledgment needs to be sent back to the peer for this message on this exchange,
// Set the flag in message header indicating an ack requested by peer;
msgFlags.Set(MessageFlagValues::kMessageFlag_PeerRequestedAck);
msgFlags.Set(MessageFlagValues::kPeerRequestedAck);

// Also set the flag in the exchange context indicating an ack requested;
mReliableMessageContext.SetPeerRequestedAck(true);
Expand Down
34 changes: 17 additions & 17 deletions src/messaging/Flags.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,44 +38,44 @@ namespace Messaging {
enum class MessageFlagValues : uint32_t
{
/**< Indicates that the existing source node identifier must be reused. */
kMessageFlag_ReuseSourceId = 0x00000020,
kReuseSourceId = 0x00000020,
/**< Indicates that the CHIP message is already encoded. */
kMessageFlag_MessageEncoded = 0x00001000,
kMessageEncoded = 0x00001000,
/**< Indicates that default IPv6 source address selection should be used when sending IPv6 multicast messages. */
kMessageFlag_DefaultMulticastSourceAddress = 0x00002000,
kDefaultMulticastSourceAddress = 0x00002000,
/**< Indicates that the sender of the message requested an acknowledgment. */
kMessageFlag_PeerRequestedAck = 0x00004000,
kPeerRequestedAck = 0x00004000,
/**< Indicates that the message is a duplicate of a previously received message. */
kMessageFlag_DuplicateMessage = 0x00008000,
kDuplicateMessage = 0x00008000,
/**< Indicates that the peer's group key message counter is not synchronized. */
kMessageFlag_PeerGroupMsgIdNotSynchronized = 0x00010000,
kPeerGroupMsgIdNotSynchronized = 0x00010000,
/**< Indicates that the source of the message is the initiator of the CHIP exchange. */
kMessageFlag_FromInitiator = 0x00020000,
kFromInitiator = 0x00020000,
/**< Indicates that message is being sent/received via the local ephemeral UDP port. */
kMessageFlag_ViaEphemeralUDPPort = 0x00040000,
kViaEphemeralUDPPort = 0x00040000,
};

using MessageFlags = BitFlags<uint32_t, MessageFlagValues>;

enum class SendMessageFlags : uint16_t
{
kSendFlag_None = 0x0000,
kNone = 0x0000,
/**< Used to indicate that automatic retransmission is enabled. */
kSendFlag_AutoRetrans = 0x0001,
kAutoRetrans = 0x0001,
/**< Used to indicate that a response is expected within a specified timeout. */
kSendFlag_ExpectResponse = 0x0002,
kExpectResponse = 0x0002,
/**< Used to indicate that the source node ID in the message header can be reused. */
kSendFlag_ReuseSourceId = 0x0020,
kReuseSourceId = 0x0020,
/**< Used to indicate that the message is already encoded. */
kSendFlag_AlreadyEncoded = 0x0080,
kAlreadyEncoded = 0x0080,
/**< Used to indicate that default IPv6 source address selection should be used when sending IPv6 multicast messages. */
kSendFlag_DefaultMulticastSourceAddress = 0x0100,
kDefaultMulticastSourceAddress = 0x0100,
/**< Used to indicate that the current message is the initiator of the exchange. */
kSendFlag_FromInitiator = 0x0200,
kFromInitiator = 0x0200,
/**< Used to send a ReliableMessageProtocol message requesting an acknowledgment. */
kSendFlag_RequestAck = 0x0400,
kRequestAck = 0x0400,
/**< Suppress the auto-request acknowledgment feature when sending a message. */
kSendFlag_NoAutoRequestAck = 0x0800,
kNoAutoRequestAck = 0x0800,
};

using SendFlags = BitFlags<uint16_t, SendMessageFlags>;
Expand Down
4 changes: 2 additions & 2 deletions src/messaging/ReliableMessageContext.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ CHIP_ERROR ReliableMessageContext::HandleNeedsAck(uint32_t MessageId, BitFlags<u
mManager->ExpireTicks();

// If the message IS a duplicate.
if (MsgFlags.Has(MessageFlagValues::kMessageFlag_DuplicateMessage))
if (MsgFlags.Has(MessageFlagValues::kDuplicateMessage))
{
#if !defined(NDEBUG)
ChipLogProgress(ExchangeManager, "Forcing tx of solitary ack for duplicate MsgId:%08" PRIX32, MessageId);
Expand Down Expand Up @@ -352,7 +352,7 @@ CHIP_ERROR ReliableMessageContext::SendStandaloneAckMessage()
{
err = mExchange->SendMessage(Protocols::kProtocol_SecureChannel,
static_cast<uint8_t>(Protocols::SecureChannel::MsgType::StandaloneAck), std::move(msgBuf),
BitFlags<uint16_t, SendMessageFlags>{ SendMessageFlags::kSendFlag_NoAutoRequestAck });
BitFlags<uint16_t, SendMessageFlags>{ SendMessageFlags::kNoAutoRequestAck });
}
else
{
Expand Down
4 changes: 2 additions & 2 deletions src/messaging/tests/TestExchangeMgr.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -258,11 +258,11 @@ void CheckExchangeMessages(nlTestSuite * inSuite, void * inContext)
err = exchangeMgr.RegisterUnsolicitedMessageHandler(0x0001, 0x0001, &mockUnsolicitedAppDelegate);

// send a malicious packet
ec1->SendMessage(0x0001, 0x0002, System::PacketBuffer::New(), SendFlags(Messaging::SendMessageFlags::kSendFlag_None));
ec1->SendMessage(0x0001, 0x0002, System::PacketBuffer::New(), SendFlags(Messaging::SendMessageFlags::kNone));
NL_TEST_ASSERT(inSuite, !mockUnsolicitedAppDelegate.IsOnMessageReceivedCalled);

// send a good packet
ec1->SendMessage(0x0001, 0x0001, System::PacketBuffer::New(), SendFlags(Messaging::SendMessageFlags::kSendFlag_None));
ec1->SendMessage(0x0001, 0x0001, System::PacketBuffer::New(), SendFlags(Messaging::SendMessageFlags::kNone));
NL_TEST_ASSERT(inSuite, mockUnsolicitedAppDelegate.IsOnMessageReceivedCalled);
}

Expand Down
2 changes: 1 addition & 1 deletion src/messaging/tests/TestReliableMessageProtocol.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ void CheckResendMessage(nlTestSuite * inSuite, void * inContext)
gSendMessageCount = 0;

err = exchange->SendMessage(kProtocol_Echo, kEchoMessageType_EchoRequest, std::move(buffer),
Messaging::SendFlags(Messaging::SendMessageFlags::kSendFlag_None));
Messaging::SendFlags(Messaging::SendMessageFlags::kNone));
NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR);

// 1 tick is 64 ms, sleep 65 ms to trigger first re-transmit
Expand Down
2 changes: 1 addition & 1 deletion src/protocols/echo/EchoClient.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ CHIP_ERROR EchoClient::SendEchoRequest(System::PacketBufferHandle payload)

// Send an Echo Request message. Discard the exchange context if the send fails.
err = mExchangeCtx->SendMessage(kProtocol_Echo, kEchoMessageType_EchoRequest, std::move(payload),
Messaging::SendFlags(Messaging::SendMessageFlags::kSendFlag_None));
Messaging::SendFlags(Messaging::SendMessageFlags::kNone));

if (err != CHIP_NO_ERROR)
{
Expand Down
2 changes: 1 addition & 1 deletion src/protocols/echo/EchoServer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ void EchoServer::OnMessageReceived(Messaging::ExchangeContext * ec, const Packet

// Send an Echo Response back to the sender.
ec->SendMessage(kProtocol_Echo, kEchoMessageType_EchoResponse, std::move(response),
Messaging::SendFlags(Messaging::SendMessageFlags::kSendFlag_None));
Messaging::SendFlags(Messaging::SendMessageFlags::kNone));

// Discard the exchange context.
ec->Close();
Expand Down

0 comments on commit ab9dda6

Please sign in to comment.