from hazelcast.protocol.codec import (
transactional_list_add_codec,
transactional_list_remove_codec,
transactional_list_size_codec,
)
from hazelcast.proxy.base import TransactionalProxy
from hazelcast.util import check_not_none, thread_id
[docs]class TransactionalList(TransactionalProxy):
"""
Transactional implementation of :class:`~hazelcast.proxy.list.List`.
"""
[docs] def add(self, item):
"""Transactional implementation of :func:`List.add(item) <hazelcast.proxy.list.List.add>`
Args:
item: The new item to be added.
Returns:
hazelcast.future.Future[bool]: ``True`` if the item is added successfully, ``False`` otherwise.
"""
check_not_none(item, "item can't be none")
item_data = self._to_data(item)
request = transactional_list_add_codec.encode_request(
self.name, self.transaction.id, thread_id(), item_data
)
return self._invoke(request, transactional_list_add_codec.decode_response)
[docs] def remove(self, item):
"""Transactional implementation of :func:`List.remove(item) <hazelcast.proxy.list.List.remove>`
Args:
item: The specified item to be removed.
Returns:
hazelcast.future.Future[bool]: ``True`` if the item is removed successfully, ``False`` otherwise.
"""
check_not_none(item, "item can't be none")
item_data = self._to_data(item)
request = transactional_list_remove_codec.encode_request(
self.name, self.transaction.id, thread_id(), item_data
)
return self._invoke(request, transactional_list_remove_codec.decode_response)
[docs] def size(self):
"""Transactional implementation of :func:`List.size() <hazelcast.proxy.list.List.size>`
Returns:
hazelcast.future.Future[int]: The size of the list.
"""
request = transactional_list_size_codec.encode_request(
self.name, self.transaction.id, thread_id()
)
return self._invoke(request, transactional_list_size_codec.decode_response)