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
- Reference: ROMessage.h
- Namespace: RemObjectsSDK
- Ancestry: NSObject | ROMessage
beginReadObjectWithName:asClass:
- (nonnull ROComplexType *) beginReadObjectWithName:(nullable NSString *)aName asClass:(nonnull Class)aClass
Parameters:
- aName:
- aClass:
beginWriteObject:withName:
- (void) beginWriteObject:(nullable ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
channel retain
@property (retain) nullable ROChannel *channel
clear
- (void) clear
clearAttributes
- (void) clearAttributes
clientID
+ (nullable ROGuid *) clientID
clientID retain
@property (retain) nullable ROGuid *clientID
contentType retain
@property (readonly, retain) nullable NSString *contentType
createExceptionWithClassName:message:
- (nonnull NSException *) createExceptionWithClassName:(nonnull NSString *)aExceptionName message:(nonnull NSString *)aMessage
Parameters:
- aExceptionName:
- aMessage:
createMessageStateObject
- (nullable ROMessageState *) createMessageStateObject
doGetNSData
- (nonnull NSMutableData *) doGetNSData
doPrepareFromNSData:
- (void) doPrepareFromNSData:(nonnull NSData *)aData
Parameters:
- aData:
doRead
- (void) doRead
doReadException:
- (void) doReadException:(nullable id)aException
Parameters:
- aException:
doReadObject:withName:
- (void) doReadObject:(nonnull ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
doWriteObject:withName:
- (void) doWriteObject:(nullable ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
endReadObject:withName:
- (void) endReadObject:(nonnull ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
endWriteObject:withName:
- (void) endWriteObject:(nullable ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
envelopes
@property (readonly) nullable NSMutableDictionary *envelopes
exception
@property (readonly) nullable NSException *exception
finalizeMessage
- (void) finalizeMessage
getAtttributeValue:
- (nullable NSString *) getAtttributeValue:(nonnull NSString *)aName
Parameters:
- aName:
getNSData
- (nonnull NSMutableData *) getNSData
initializeAsRequestMessage:libraryName:interfaceName:messageName:
- (void) initializeAsRequestMessage:(nonnull ROChannel *)aChannel libraryName:(nonnull NSString *)aLibraryName interfaceName:(nonnull NSString *)anInterfaceName messageName:(nonnull NSString *)aMessageName
Parameters:
- aChannel:
- aLibraryName:
- anInterfaceName:
- aMessageName:
initializeMessage:libraryName:interfaceName:messageName:messageType:
- (void) initializeMessage:(nonnull ROChannel *)aChannel libraryName:(nonnull NSString *)aLibraryName interfaceName:(nonnull NSString *)anInterfaceName messageName:(nonnull NSString *)aMessageName messageType:(enum ROMessageType)aMessageType
Parameters:
- aChannel:
- aLibraryName:
- anInterfaceName:
- aMessageName:
- aMessageType:
interfaceName copy
@property (copy) nonnull NSString *interfaceName
libraryName copy
@property (copy) nonnull NSString *libraryName
message
+ (nonnull instancetype) message
messageMatchingTargetURL:
+ (nonnull instancetype) messageMatchingTargetURL:(nonnull NSURL *)targetUrl
Parameters:
- targetUrl:
messageName copy
@property (copy) nonnull NSString *messageName
messageType
@property (readonly) enum ROMessageType messageType
prepareFromNSData:
- (void) prepareFromNSData:(nonnull NSData *)aData
Parameters:
- aData:
processException
- (void) processException
read
- (void) read
readAnsiString
- (nullable NSString *) readAnsiString
readAnsiStringWithName:
- (nullable NSString *) readAnsiStringWithName:(nullable NSString *)aName
Parameters:
- aName:
readByte
- (unsigned char) readByte
readException
- (nonnull NSException *) readException
readFromNSData:
- (void) readFromNSData:(nonnull NSData *)aData
Parameters:
- aData:
readUtf8String
- (nullable NSString *) readUtf8String
readUtf8StringWithName:
- (nullable NSString *) readUtf8StringWithName:(nullable NSString *)aName
Parameters:
- aName:
readWideString
- (nullable NSString *) readWideString
readWideStringWithName:
- (nullable NSString *) readWideStringWithName:(nullable NSString *)aName
Parameters:
- aName:
restoreMessageState:usingChannel:
- (void) restoreMessageState:(nonnull ROMessageState *)aState usingChannel:(nonnull ROChannel *)aChannel
Parameters:
- aState:
- aChannel:
saveMessageState
- (nullable ROMessageState *) saveMessageState
setupAttributes:
- (void) setupAttributes:(nonnull NSDictionary *)aAttributes
Parameters:
- aAttributes:
setUseSingleClientID:
+ (void) setUseSingleClientID:(BOOL)flag
Parameters:
- flag:
useSingleClientID
+ (BOOL) useSingleClientID
useStrictFieldOrderForStructs
@property (readonly) BOOL useStrictFieldOrderForStructs
writeToNSData:
- (void) writeToNSData:(nonnull NSMutableData *)aData
Parameters:
- aData:
channel retain
@property (retain) nullable ROChannel *channel
clientID retain
@property (retain) nullable ROGuid *clientID
contentType retain
@property (readonly, retain) nullable NSString *contentType
envelopes
@property (readonly) nullable NSMutableDictionary *envelopes
exception
@property (readonly) nullable NSException *exception
interfaceName copy
@property (copy) nonnull NSString *interfaceName
libraryName copy
@property (copy) nonnull NSString *libraryName
messageName copy
@property (copy) nonnull NSString *messageName
messageType
@property (readonly) enum ROMessageType messageType
useStrictFieldOrderForStructs
@property (readonly) BOOL useStrictFieldOrderForStructs
clientID
+ (nullable ROGuid *) clientID
message
+ (nonnull instancetype) message
messageMatchingTargetURL:
+ (nonnull instancetype) messageMatchingTargetURL:(nonnull NSURL *)targetUrl
Parameters:
- targetUrl:
setUseSingleClientID:
+ (void) setUseSingleClientID:(BOOL)flag
Parameters:
- flag:
useSingleClientID
+ (BOOL) useSingleClientID
beginReadObjectWithName:asClass:
- (nonnull ROComplexType *) beginReadObjectWithName:(nullable NSString *)aName asClass:(nonnull Class)aClass
Parameters:
- aName:
- aClass:
beginWriteObject:withName:
- (void) beginWriteObject:(nullable ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
clear
- (void) clear
clearAttributes
- (void) clearAttributes
createExceptionWithClassName:message:
- (nonnull NSException *) createExceptionWithClassName:(nonnull NSString *)aExceptionName message:(nonnull NSString *)aMessage
Parameters:
- aExceptionName:
- aMessage:
createMessageStateObject
- (nullable ROMessageState *) createMessageStateObject
doGetNSData
- (nonnull NSMutableData *) doGetNSData
doPrepareFromNSData:
- (void) doPrepareFromNSData:(nonnull NSData *)aData
Parameters:
- aData:
doRead
- (void) doRead
doReadException:
- (void) doReadException:(nullable id)aException
Parameters:
- aException:
doReadObject:withName:
- (void) doReadObject:(nonnull ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
doWriteObject:withName:
- (void) doWriteObject:(nullable ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
endReadObject:withName:
- (void) endReadObject:(nonnull ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
endWriteObject:withName:
- (void) endWriteObject:(nullable ROComplexType *)anObject withName:(nullable NSString *)aName
Parameters:
- anObject:
- aName:
finalizeMessage
- (void) finalizeMessage
getAtttributeValue:
- (nullable NSString *) getAtttributeValue:(nonnull NSString *)aName
Parameters:
- aName:
getNSData
- (nonnull NSMutableData *) getNSData
initializeAsRequestMessage:libraryName:interfaceName:messageName:
- (void) initializeAsRequestMessage:(nonnull ROChannel *)aChannel libraryName:(nonnull NSString *)aLibraryName interfaceName:(nonnull NSString *)anInterfaceName messageName:(nonnull NSString *)aMessageName
Parameters:
- aChannel:
- aLibraryName:
- anInterfaceName:
- aMessageName:
initializeMessage:libraryName:interfaceName:messageName:messageType:
- (void) initializeMessage:(nonnull ROChannel *)aChannel libraryName:(nonnull NSString *)aLibraryName interfaceName:(nonnull NSString *)anInterfaceName messageName:(nonnull NSString *)aMessageName messageType:(enum ROMessageType)aMessageType
Parameters:
- aChannel:
- aLibraryName:
- anInterfaceName:
- aMessageName:
- aMessageType:
prepareFromNSData:
- (void) prepareFromNSData:(nonnull NSData *)aData
Parameters:
- aData:
processException
- (void) processException
read
- (void) read
readAnsiString
- (nullable NSString *) readAnsiString
readAnsiStringWithName:
- (nullable NSString *) readAnsiStringWithName:(nullable NSString *)aName
Parameters:
- aName:
readByte
- (unsigned char) readByte
readException
- (nonnull NSException *) readException
readFromNSData:
- (void) readFromNSData:(nonnull NSData *)aData
Parameters:
- aData:
readUtf8String
- (nullable NSString *) readUtf8String
readUtf8StringWithName:
- (nullable NSString *) readUtf8StringWithName:(nullable NSString *)aName
Parameters:
- aName:
readWideString
- (nullable NSString *) readWideString
readWideStringWithName:
- (nullable NSString *) readWideStringWithName:(nullable NSString *)aName
Parameters:
- aName:
restoreMessageState:usingChannel:
- (void) restoreMessageState:(nonnull ROMessageState *)aState usingChannel:(nonnull ROChannel *)aChannel
Parameters:
- aState:
- aChannel:
saveMessageState
- (nullable ROMessageState *) saveMessageState
setupAttributes:
- (void) setupAttributes:(nonnull NSDictionary *)aAttributes
Parameters:
- aAttributes:
writeToNSData:
- (void) writeToNSData:(nonnull NSMutableData *)aData
Parameters:
- aData: