ROMessageEnvelope

Overview

ROMessageEnvelope is the abstract base class for Message Envelope implementations in Remoting SDK for Xcode.

You will usually not instantiate instances of this class itself, but use the descendant classes such as ROAESEncryptionEnvelope, or write your own.

Location

 

defaultEnvelopeMarker

+ (NSString *) defaultEnvelopeMarker

enabled  assign

@property (assign) BOOL enabled

envelopeMarker  copy

@property (copy) NSString *envelopeMarker

unwrapMessageFromData:

for internal use; Unwraps a message from the given block of NSData. Internally calls unwrapMessageFromData:offset: with an offset of 0.

- (NSData *) unwrapMessageFromData:(NSData *)aData

Parameters:

  • aData:

unwrapMessageFromData:offset:

for internal use; Must be implemented in concrete envelopes to unwrap a message from the given block of NSData at the specified offset.

- (NSData *) unwrapMessageFromData:(NSData *)aData offset:(long)aOffset

Parameters:

  • aData:
  • aOffset:

wrapMessage:toData:clientID:

for internal use; Must be implemented in a concrete envelope to wrap the given message data to the NSData. The ClientID is provided for reference, and may be encoded in the envelopes header, if needed for unwrapping on the remote side.

- (void) wrapMessage:(NSData *)aMessageData toData:(NSMutableData *)aData clientID:(ROGuid *)aClientID

Parameters:

  • aMessageData:
  • aData:
  • aClientID:

 

enabled  assign

@property (assign) BOOL enabled

envelopeMarker  copy

@property (copy) NSString *envelopeMarker

 

defaultEnvelopeMarker

+ (NSString *) defaultEnvelopeMarker

 

unwrapMessageFromData:

for internal use; Unwraps a message from the given block of NSData. Internally calls unwrapMessageFromData:offset: with an offset of 0.

- (NSData *) unwrapMessageFromData:(NSData *)aData

Parameters:

  • aData:

unwrapMessageFromData:offset:

for internal use; Must be implemented in concrete envelopes to unwrap a message from the given block of NSData at the specified offset.

- (NSData *) unwrapMessageFromData:(NSData *)aData offset:(long)aOffset

Parameters:

  • aData:
  • aOffset:

wrapMessage:toData:clientID:

for internal use; Must be implemented in a concrete envelope to wrap the given message data to the NSData. The ClientID is provided for reference, and may be encoded in the envelopes header, if needed for unwrapping on the remote side.

- (void) wrapMessage:(NSData *)aMessageData toData:(NSMutableData *)aData clientID:(ROGuid *)aClientID

Parameters:

  • aMessageData:
  • aData:
  • aClientID:

Descendants

See Also