Package deltavsoft :: Module rcfproto :: Class RcfProtoChannel |
[frames] | no frames]

# Class RcfProtoChannel

source code

    google.protobuf.service.RpcChannel --+
                                         |
                                        RcfProtoChannel

Represents a single RPC connection to a server.

Instance Methods
__init__(self, *args) Constructs a RPC channel from an endpoint. | source code
Failed(self) After a call has finished, returns true if the call failed. | source code
ErrorText(self) If Failed() is true, returns a human-readable description of the error. | source code
StartCancel(self) Advises the RPC system that the caller desires that the RPC call be canceled. | source code
Connect(self) Connects to the server. | source code
Disconnect(self) Disconencts from the server. | source code
SetRemoteCallTimeoutMs(self, *args) Sets the remote call timeout value, in milliseconds. | source code
GetRemoteCallTimeoutMs(self) Gets the remote call timeout value, in milliseconds. | source code
SetConnectTimeoutMs(self, *args) Sets the connect timeout value, in milliseconds. | source code
GetConnectTimeoutMs(self) Gets the connect timeout value, in milliseconds. | source code
SetTransportProtocol(self, *args) Sets the transport protocol being used by the channel. | source code
GetTransportProtocol(self) Gets the transport protocol being used by the channel. | source code
SetEnableAsynchronousRpc(self, *args) Sets the enable asynchronous RPC setting. | source code
GetEnableAsynchronousRpc(self) Gets the enable synchronous RPC setting. | source code
SetPingBackIntervalMs(self, *args) Sets the ping back interval of the connection, in milliseconds. | source code
GetPingBackIntervalMs(self) Returns the ping back interval of the connection. | source code
SetHttpProxy(self, *args) Sets the network address of the HTTP proxy server, through which to route remote calls. | source code
GetHttpProxy(self) Returns the network address of the HTTP proxy server. | source code
SetHttpProxyPort(self, *args) Sets the port number of the HTTP proxy server, through which to route remote calls. | source code
GetHttpProxyPort(self) Returns the port number of the HTTP proxy server. | source code
GetTransportType(self) Returns the transport type of the connection. | source code
SetUsername(self, *args) Sets the Windows username to use when connecting. | source code
GetUsername(self) Returns the Windows username to use when connecting. | source code
SetPassword(self, *args) Sets the Windows password to use when connecting. | source code
GetPassword(self) Returns the Windows password to use when connecting. | source code
SetKerberosSpn(self, *args) Sets the Kerberos SPN to use when connecting. | source code
GetKerberosSpn(self) Returns the Kerberos SPN to use when connecting. | source code
SetEnableCompression(self, *args) Sets the transport level compression setting for this connection. | source code
GetEnableCompression(self) Returns the transport level compression setting for this connection. | source code
SetCertificate(self, *args) Sets the SSL certificate for the channel. | source code
GetCertificate(self) Gets the SSL certificate for the channel. | source code
SetCaCertificate(self, *args) Sets the certificate authority for the channel. | source code
GetCaCertificate(self) Gets the certificate authority for the channel. | source code
SetOpenSslCipherSuite(self, *args) Sets the OpenSSL cipher suite. | source code
GetOpenSslCipherSuite(self) Gets the OpenSSL cipher suite. | source code
SetEnableSchannelCertificateValidation(self, *args) Sets the Schannel certificate validation setting. | source code
GetEnableSchannelCertificateValidation(self) Gets the Schannel certificate validation setting. | source code
SetSslImplementation(self, *args) Sets the SSL implementation to be used by the channel. | source code
GetSslImplementation(self) Gets the SSL implementation. | source code
CallMethod(self, methodDesc, controller, request, responsePrototype, done) Gets the certificate validation callback. | source code
GetResponse(self) | source code
SetCertificateValidationCallback(self, certValidationCallback) | source code

Method Details

### Failed(self) | source code
After a call has finished, returns true if the call failed. The possible reasons for failure depend on the RPC implementation. Failed() must not be called before a call has finished. If Failed() returns true, the contents of the response message are undefined.

### StartCancel(self) | source code
Advises the RPC system that the caller desires that the RPC call be canceled. The RPC system may cancel it immediately, may wait awhile and then cancel it, or may not even cancel the call at all. If the call is canceled, the "done" callback will still be called and the RpcController will indicate that the call failed at that time.

### SetEnableAsynchronousRpc(self, *args) | source code
Sets the enable asynchronous RPC setting. By default asynchronous RPC is disabled.

### SetPingBackIntervalMs(self, *args) | source code
Sets the ping back interval of the connection, in milliseconds. Ping backs are sent from the server back to the client, while a remote call is in progress.

### SetHttpProxy(self, *args) | source code
Sets the network address of the HTTP proxy server, through which to route remote calls. Only valid when using a HTTP or HTTPS endpoint.

### SetHttpProxyPort(self, *args) | source code
Sets the port number of the HTTP proxy server, through which to route remote calls. Only valid when using a HTTP or HTTPS endpoint.

### SetUsername(self, *args) | source code
Sets the Windows username to use when connecting. Only valid for NTLM and Kerberos transport protocols.

### SetPassword(self, *args) | source code
Sets the Windows password to use when connecting. Only valid for NTLM and Kerberos transport protocols.

### SetKerberosSpn(self, *args) | source code
Sets the Kerberos SPN to use when connecting. Only valid for Kerberos transport protocols.

### SetOpenSslCipherSuite(self, *args) | source code
Sets the OpenSSL cipher suite. Only applicable when using OpenSSL as the SSL implementation.

### SetEnableSchannelCertificateValidation(self, *args) | source code
Sets the Schannel certificate validation setting. Only applicable when using Schannel as the SSL implementation. If this setting is non-empty, it will be used by Schannel to automatically validate peer certificates.