ROMessage

Overview

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

You will usually not instantiate instances of this class itself, but use the descendant classes such as ROBinMessage.

Location

 

beginReadObjectWithName:asClass:

- (ROComplexType *) beginReadObjectWithName:(NSString *)aName asClass:(Class)aClass

Parameters:

  • aName:
  • aClass:

beginWriteObject:withName:

- (void) beginWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

channel  retain

@property (retain) ROChannel *channel

clear

- (void) clear

clearAttributes

- (void) clearAttributes

clientID  retain

@property (retain) ROGuid *clientID

contentType  retain

@property (readonly, retain) NSString *contentType

createExceptionWithClassName:message:

- (NSException *) createExceptionWithClassName:(NSString *)aExceptionName message:(NSString *)aMessage

Parameters:

  • aExceptionName:
  • aMessage:

doGetNSData

- (NSMutableData *) doGetNSData

doPrepareFromNSData:

- (void) doPrepareFromNSData:(NSData *)aData

Parameters:

  • aData:

doRead

- (void) doRead

doReadException:

- (void) doReadException:(id)aException

Parameters:

  • aException:

doReadObject:withName:

- (void) doReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

doWriteObject:withName:

- (void) doWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endReadObject:withName:

- (void) endReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endWriteObject:withName:

- (void) endWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

envelopes

@property (readonly) NSMutableDictionary *envelopes

exception

@property (readonly) NSException *exception

finalizeMessage

- (void) finalizeMessage

getAtttributeValue:

- (NSString *) getAtttributeValue:(NSString *)aName

Parameters:

  • aName:

getNSData

- (NSMutableData *) getNSData

initializeAsRequestMessage:libraryName:interfaceName:messageName:

- (void) initializeAsRequestMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:

initializeMessage:libraryName:interfaceName:messageName:messageType:

- (void) initializeMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName messageType:(enum ROMessageType)aMessageType

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:
  • aMessageType:

interfaceName  copy

@property (copy) NSString *interfaceName

libraryName  copy

@property (copy) NSString *libraryName

message

Creates and returns a new instance of the message class.

+ (id) message

messageMatchingTargetURL:

+ (id) messageMatchingTargetURL:(NSURL *)targetUrl

Parameters:

  • targetUrl:

messageName  copy

@property (copy) NSString *messageName

messageType

@property (readonly) enum ROMessageType messageType

prepareFromNSData:

- (void) prepareFromNSData:(NSData *)aData

Parameters:

  • aData:

processException

- (void) processException

read

- (void) read

readAnsiString

- (NSString *) readAnsiString

readAnsiStringWithName:

- (NSString *) readAnsiStringWithName:(NSString *)aName

Parameters:

  • aName:

readByte

- (unsigned char) readByte

readException

- (NSException *) readException

readFromNSData:

- (void) readFromNSData:(NSData *)aData

Parameters:

  • aData:

readUtf8String

- (NSString *) readUtf8String

readUtf8StringWithName:

- (NSString *) readUtf8StringWithName:(NSString *)aName

Parameters:

  • aName:

readWideString

- (NSString *) readWideString

readWideStringWithName:

- (NSString *) readWideStringWithName:(NSString *)aName

Parameters:

  • aName:

setupAttributes:

- (void) setupAttributes:(NSDictionary *)aAttributes

Parameters:

  • aAttributes:

setUseSingleClientID:

+ (void) setUseSingleClientID:(BOOL)flag

Parameters:

  • flag:

useSingleClientID

+ (BOOL) useSingleClientID

useStrictFieldOrderForStructs

- (BOOL) useStrictFieldOrderForStructs

writeToNSData:

- (void) writeToNSData:(NSMutableData *)aData

Parameters:

  • aData:

 

channel  retain

@property (retain) ROChannel *channel

clientID  retain

@property (retain) ROGuid *clientID

contentType  retain

@property (readonly, retain) NSString *contentType

envelopes

@property (readonly) NSMutableDictionary *envelopes

exception

@property (readonly) NSException *exception

interfaceName  copy

@property (copy) NSString *interfaceName

libraryName  copy

@property (copy) NSString *libraryName

messageName  copy

@property (copy) NSString *messageName

messageType

@property (readonly) enum ROMessageType messageType

 

message

Creates and returns a new instance of the message class.

+ (id) message

messageMatchingTargetURL:

+ (id) messageMatchingTargetURL:(NSURL *)targetUrl

Parameters:

  • targetUrl:

setUseSingleClientID:

+ (void) setUseSingleClientID:(BOOL)flag

Parameters:

  • flag:

useSingleClientID

+ (BOOL) useSingleClientID

 

beginReadObjectWithName:asClass:

- (ROComplexType *) beginReadObjectWithName:(NSString *)aName asClass:(Class)aClass

Parameters:

  • aName:
  • aClass:

beginWriteObject:withName:

- (void) beginWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

clear

- (void) clear

clearAttributes

- (void) clearAttributes

createExceptionWithClassName:message:

- (NSException *) createExceptionWithClassName:(NSString *)aExceptionName message:(NSString *)aMessage

Parameters:

  • aExceptionName:
  • aMessage:

doGetNSData

- (NSMutableData *) doGetNSData

doPrepareFromNSData:

- (void) doPrepareFromNSData:(NSData *)aData

Parameters:

  • aData:

doRead

- (void) doRead

doReadException:

- (void) doReadException:(id)aException

Parameters:

  • aException:

doReadObject:withName:

- (void) doReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

doWriteObject:withName:

- (void) doWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endReadObject:withName:

- (void) endReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endWriteObject:withName:

- (void) endWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

finalizeMessage

- (void) finalizeMessage

getAtttributeValue:

- (NSString *) getAtttributeValue:(NSString *)aName

Parameters:

  • aName:

getNSData

- (NSMutableData *) getNSData

initializeAsRequestMessage:libraryName:interfaceName:messageName:

- (void) initializeAsRequestMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:

initializeMessage:libraryName:interfaceName:messageName:messageType:

- (void) initializeMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName messageType:(enum ROMessageType)aMessageType

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:
  • aMessageType:

prepareFromNSData:

- (void) prepareFromNSData:(NSData *)aData

Parameters:

  • aData:

processException

- (void) processException

read

- (void) read

readAnsiString

- (NSString *) readAnsiString

readAnsiStringWithName:

- (NSString *) readAnsiStringWithName:(NSString *)aName

Parameters:

  • aName:

readByte

- (unsigned char) readByte

readException

- (NSException *) readException

readFromNSData:

- (void) readFromNSData:(NSData *)aData

Parameters:

  • aData:

readUtf8String

- (NSString *) readUtf8String

readUtf8StringWithName:

- (NSString *) readUtf8StringWithName:(NSString *)aName

Parameters:

  • aName:

readWideString

- (NSString *) readWideString

readWideStringWithName:

- (NSString *) readWideStringWithName:(NSString *)aName

Parameters:

  • aName:

setupAttributes:

- (void) setupAttributes:(NSDictionary *)aAttributes

Parameters:

  • aAttributes:

useStrictFieldOrderForStructs

- (BOOL) useStrictFieldOrderForStructs

writeToNSData:

- (void) writeToNSData:(NSMutableData *)aData

Parameters:

  • aData:

Descendants

See Also