Add experimental API note.

pull/19971/head
Lidi Zheng 5 years ago
parent 227a7cb47b
commit c45fb12ffb
  1. 4
      src/python/grpcio/grpc/__init__.py

@ -1759,6 +1759,8 @@ class LocalConnectionType(enum.Enum):
def local_channel_credentials(local_connect_type=LocalConnectionType.LOCAL_TCP): def local_channel_credentials(local_connect_type=LocalConnectionType.LOCAL_TCP):
"""Creates a local ChannelCredentials used for local connections. """Creates a local ChannelCredentials used for local connections.
This is an EXPERIMENTAL API.
Local credentials are used by local TCP endpoints (e.g. localhost:10000) Local credentials are used by local TCP endpoints (e.g. localhost:10000)
also UDS connections. It allows them to create secure channel, hence also UDS connections. It allows them to create secure channel, hence
transmitting call credentials become possible. transmitting call credentials become possible.
@ -1780,6 +1782,8 @@ def local_channel_credentials(local_connect_type=LocalConnectionType.LOCAL_TCP):
def local_server_credentials(local_connect_type=LocalConnectionType.LOCAL_TCP): def local_server_credentials(local_connect_type=LocalConnectionType.LOCAL_TCP):
"""Creates a local ServerCredentials used for local connections. """Creates a local ServerCredentials used for local connections.
This is an EXPERIMENTAL API.
Local credentials are used by local TCP endpoints (e.g. localhost:10000) Local credentials are used by local TCP endpoints (e.g. localhost:10000)
also UDS connections. It allows them to create secure channel, hence also UDS connections. It allows them to create secure channel, hence
transmitting call credentials become possible. transmitting call credentials become possible.

Loading…
Cancel
Save