Added -[RMQConnection updateSecret:]

Author: aurban-iqmessenger

RMQClient/RMQConnection.h

@@ -242,4 +242,12 @@
  */
 - (nonnull id<RMQChannel>)createChannel;
 
+/*!
+ * @brief Update secret.
+ * This method updates the secret used to authenticate this connection.
+ * It is used when secrets have an expiration date and need to be renewed, like OAuth 2 tokens.
+ * @param secret    The new secret.
+ */
+- (void)updateSecret:(NSString *)secret;
+
 @end

RMQClient/RMQConnection.m

@@ -608,6 +608,13 @@ - (void)start {
     return ch;
 }
 
+- (void)updateSecret:(NSString *)secret
+{
+    [self.commandQueue enqueue:^{
+        [self sendFrameset:[[RMQFrameset alloc] initWithChannelNumber:@0 method:[self methodForUpdateSecret:secret]]];
+    }];
+}
+
 - (BOOL)hasCompletedHandshake {
     return self.handshakeComplete;
 }
@@ -746,6 +753,13 @@ - (void)closeAllUserChannels {
     }
 }
 
+- (RMQConnectionUpdateSecret *)methodForUpdateSecret:(NSString *)secret {
+    RMQLongstr *secretLongstr = [[RMQLongstr alloc] init:secret];
+    RMQShortstr *reason = [[RMQShortstr alloc] init:@"ObjC client needs it"];
+    return [[RMQConnectionUpdateSecret alloc] initWithSecret:secretLongstr
+                                                      reason:reason];
+}
+
 - (RMQConnectionClose *)amqClose {
     return [[RMQConnectionClose alloc] initWithReplyCode:[[RMQShort alloc] init:200]
                                                replyText:[[RMQShortstr alloc] init:@"Goodbye"]

RMQClient/RMQMethodMap.m

@@ -58,6 +58,8 @@ + (NSDictionary *)methodMap {
              @[@(10), @(51)] : [RMQConnectionCloseOk class],
              @[@(10), @(60)] : [RMQConnectionBlocked class],
              @[@(10), @(61)] : [RMQConnectionUnblocked class],
+             @[@(10), @(70)] : [RMQConnectionUpdateSecret class],
+             @[@(10), @(71)] : [RMQConnectionUpdateSecretOk class],
              @[@(20), @(10)] : [RMQChannelOpen class],
              @[@(20), @(11)] : [RMQChannelOpenOk class],
              @[@(20), @(20)] : [RMQChannelFlow class],

RMQClient/RMQMethods.h

@@ -126,6 +126,15 @@ typedef NS_OPTIONS(NSUInteger, RMQConnectionOpenOptions) {
 @end
 @interface RMQConnectionUnblocked : RMQValue <RMQMethod>
 
+@end
+@interface RMQConnectionUpdateSecret : RMQValue <RMQMethod>
+@property (nonnull, copy, nonatomic, readonly) RMQLongstr *secret;
+@property (nonnull, copy, nonatomic, readonly) RMQShortstr *reason;
+- (nonnull instancetype)initWithSecret:(nonnull RMQLongstr *)secret
+                                reason:(nonnull RMQShortstr *)reason;
+@end
+@interface RMQConnectionUpdateSecretOk : RMQValue <RMQMethod>
+
 @end
 @interface RMQChannelOpen : RMQValue <RMQMethod>
 @property (nonnull, copy, nonatomic, readonly) RMQShortstr *reserved1;

RMQClient/RMQMethods.m

@@ -679,6 +679,97 @@ - (NSNumber *)frameTypeID   { return @1; }
 - (BOOL)hasContent          { return NO; }
 
 
+- (instancetype)initWithDecodedFrame:(NSArray *)frame {
+    self = [super init];
+    if (self) {
+        self.payloadArguments = @[];
+    }
+    return self;
+}
+
+- (NSData *)amqEncoded {
+    NSMutableData *encoded = [NSMutableData new];
+    [encoded appendData:[[RMQShort alloc] init:self.classID.integerValue].amqEncoded];
+    [encoded appendData:[[RMQShort alloc] init:self.methodID.integerValue].amqEncoded];
+    for (id<RMQEncodable>arg in self.payloadArguments) {
+        [encoded appendData:arg.amqEncoded];
+    }
+    return encoded;
+}
+
+@end
+
+@interface RMQConnectionUpdateSecret ()
+@property (nonnull, copy, nonatomic, readwrite) RMQLongstr *secret;
+@property (nonnull, copy, nonatomic, readwrite) RMQShortstr *reason;
+@property (nonatomic, readwrite) NSArray *payloadArguments;
+@property (nonatomic, readwrite) BOOL hasContent;
+@end
+
+@implementation RMQConnectionUpdateSecret
+
++ (NSArray *)propertyClasses {
+    return @[[RMQLongstr class],
+             [RMQShortstr class]];
+}
+- (NSNumber *)classID       { return @10; }
+- (NSNumber *)methodID      { return @70; }
+- (Class)syncResponse       { return [RMQConnectionUpdateSecretOk class]; }
+- (NSNumber *)frameTypeID   { return @1; }
+- (BOOL)hasContent          { return NO; }
+
+- (nonnull instancetype)initWithSecret:(nonnull RMQLongstr *)secret
+                                reason:(nonnull RMQShortstr *)reason {
+    self = [super init];
+    if (self) {
+        self.secret = secret;
+        self.reason = reason;
+        self.payloadArguments = @[self.secret,
+                                  self.reason];
+    }
+    return self;
+}
+
+- (instancetype)initWithDecodedFrame:(NSArray *)frame {
+    self = [super init];
+    if (self) {
+        self.secret = ((RMQLongstr *)frame[0]);
+        self.reason = ((RMQShortstr *)frame[1]);
+        self.payloadArguments = @[self.secret,
+                                  self.reason];
+    }
+    return self;
+}
+
+- (NSData *)amqEncoded {
+    NSMutableData *encoded = [NSMutableData new];
+    [encoded appendData:[[RMQShort alloc] init:self.classID.integerValue].amqEncoded];
+    [encoded appendData:[[RMQShort alloc] init:self.methodID.integerValue].amqEncoded];
+    for (id<RMQEncodable>arg in self.payloadArguments) {
+        [encoded appendData:arg.amqEncoded];
+    }
+    return encoded;
+}
+
+@end
+
+@interface RMQConnectionUpdateSecretOk ()
+@property (nonatomic, readwrite) NSArray *payloadArguments;
+@property (nonatomic, readwrite) BOOL hasContent;
+@end
+
+@implementation RMQConnectionUpdateSecretOk
+
++ (NSArray *)propertyClasses {
+    return @[];
+}
+- (NSNumber *)classID       { return @10; }
+- (NSNumber *)methodID      { return @71; }
+- (Class)syncResponse       { return nil; }
+- (NSNumber *)frameTypeID   { return @1; }
+- (BOOL)hasContent          { return NO; }
+
+
 - (instancetype)initWithDecodedFrame:(NSArray *)frame {
     self = [super init];
     if (self) {

codegen/amqp0-9-1.extended.xml

@@ -4,6 +4,7 @@
      WARNING: Modified from the official 0-9-1 specification XML by
      the addition of:
      confirm.select and confirm.select-ok,
+     connection.update-secret and connection.update-secret-ok,
      exchange.bind and exchange.bind-ok,
      exchange.unbind and exchange.unbind-ok,
      basic.nack,
@@ -914,6 +915,35 @@
       <chassis name = "server" implement = "MUST"/>
       <chassis name = "client" implement = "MUST"/>
     </method>
+
+    <method name = "update-secret" synchronous = "1" index = "70" label = "update secret">
+        <doc>
+            This method updates the secret used to authenticate this connection. It is used when secrets have an expiration date and need to be renewed, like OAuth 2 tokens.
+        </doc>
+        
+        <chassis name = "client" implement = "MUST" />
+        <response name = "update-secret-ok" />
+        
+        <field name = "secret" domain = "longstr">
+            <doc>
+                The new secret.
+            </doc>
+        </field>
+        
+        <field name = "reason" domain = "shortstr">
+            <doc>
+                The reason for the secret update.
+            </doc>
+        </field>
+    </method>
+    
+    <method name = "update-secret-ok" synchronous = "1" index = "71" label = "update secret response">
+        <doc>
+            This method confirms the updated secret is valid.
+        </doc>
+        <chassis name = "server" implement = "MUST" />
+    </method>
+    
   </class>
 
   <!-- ==  CHANNEL  ========================================================== -->